Skip to content

Commit

Permalink
Updated install instructions to be able to use PyPi
Browse files Browse the repository at this point in the history
  • Loading branch information
Nick Swainston committed Nov 16, 2023
1 parent 1df814b commit 50efe79
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 13 deletions.
20 changes: 14 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,10 @@ Command line interface and python package for interacting with the MeerTime data

## Installation

To install run
```
poetry install
```
or if you don't use poetry, you can instead run
To install `psrdb` run the following command:

```
pip install .
pip install psrdb
```

To interact with the database you need to get an account on the [pulsars.org.au](https://pulsars.org.au) website.
Expand All @@ -25,6 +21,18 @@ Set this token using the following command (you can put this in your `~/.bashrc`
export PSRDB_TOKEN=tokenhere
```

If you want to the current unreleased version, you can clone the repository and run

```
poetry install
```

or if you don't use poetry, you can instead run

```
pip install .
```

## How to use

Instructions and examples of how to use `psrdb` can be found in the [documentation](https://psrdb.readthedocs.io/en/latest/how_to_use.html).
20 changes: 14 additions & 6 deletions docs/installation.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,9 @@
# Installation

To install run
```
poetry install
```
or if you don't use poetry, you can instead run
To install `psrdb` run the following command:

```
pip install .
pip install psrdb
```

To interact with the database you need to get an account on the [pulsars.org.au](https://pulsars.org.au) website.
Expand All @@ -18,6 +14,18 @@ Set this token using the following command (you can put this in your `~/.bashrc`
export PSRDB_TOKEN=tokenhere
```

If you want to the current unreleased version, you can clone the repository and run

```
poetry install
```

or if you don't use poetry, you can instead run

```
pip install .
```

## Optional

If you want to change the default url of https://pulsars.org.au/api/, you can change it by setting:
Expand Down
1 change: 0 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ remove_fluxcals = "psrdb.scripts.remove_fluxcals:main"
[tool.poetry.dependencies]
python = "^3.9"
requests = "^2.25.1"
pytest = "^7.3.1"
python-decouple = "^3.8"
pulsar-paragraph = "^1.0.1"

Expand Down

0 comments on commit 50efe79

Please sign in to comment.