Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
NickSwainston committed Nov 8, 2023
1 parent 45bd19d commit 5a304a8
Showing 1 changed file with 4 additions and 17 deletions.
21 changes: 4 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,27 +17,14 @@ or if you don't use poetry, you can instead run
pip install .
```

To use the database you need a download token to read it or an ingest token to read and write/upload to it.
To interact with the database you need to get an account on the [pulsars.org.au](https://pulsars.org.au) website.
Once you have an account you then need to generate a token on this [page](https://pulsars.org.au/token_generate/).

To get a read token run
```
get_token.sh
```

The output token should be set as an environment variable using
Set this token using the following command (you can put this in your `~/.bashrc`):
```
export PSRDB_TOKEN=tokenhere
export PSRDB_URL=https://pulsars.org.au/api/graphql/
```

## How to use

The command line interface can be used to list various tables in the database.
The first arguments is the table name and the second is the action.
For example if I wanted to list all observations of pulsar J1652-4838 I could use:

```
meerdb observations list --pulsar J1652-4838
```

If you're unsure which arguments you require you can use `-h` to list your options.
Instructions and examples of how to use `psrdb` can be found in the [documentation](https://psrdb.readthedocs.io/en/latest/how_to_use.html).

0 comments on commit 5a304a8

Please sign in to comment.