CHIME FRB API¶

Ten words or less

A lightweight python library to interact with the CHIME/FRB backends.

Example

Python

from chime_frb_api.backends import frb_master

master = frb_master.FRBMaster()
master.events.get_event(71780218)
{
    "beam_numbers": [185],
    "event_type": "EXTRAGALACTIC",
    "fpga_time": 1838000314368,
    "id": 71780218,
}

Breaking Changes in v4.0+

CHIME/FRB Buckets & Results API have been consolidated under the workflow package.
We recommend migrating to use the Workflow API instead.
Python
```
from workflow.http.context import HTTPContext

ctx = HTTPContext()
ctx.results.info()
```
Workflow Setup
- Since workflow supports multiple tenants, you need to specify the workspace. Workspace are the settings required to interact with correct service endpoints.
- You can set the workspace using the cli command,
  Bash
```
workflow workspace set chimefrb
```
Pin chime-frb-api to 3.4.0 in your project's dependencies.
Bash
```
poetry update chime-frb-api==3.4.0
```

Get Started Go to GitHub