diff --git a/README.md b/README.md index bdbf9cc..31177f2 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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). \ No newline at end of file diff --git a/docs/installation.md b/docs/installation.md index 79e3f0a..071d6c9 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -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. @@ -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: diff --git a/pyproject.toml b/pyproject.toml index 69c184f..5ccf121 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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"