From 1f2a91b8b271adbae50100215200ed528f375dab Mon Sep 17 00:00:00 2001 From: Callum Rollo Date: Thu, 21 Nov 2024 09:53:27 +0100 Subject: [PATCH] Add conda install We are now on conda-forge! This completes #1 the packaging pathway mega issue --- README.md | 27 +++++++++++++++++---------- 1 file changed, 17 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 52ae966..ff73e89 100644 --- a/README.md +++ b/README.md @@ -6,31 +6,38 @@ This is a work in progress, all contributions welcome! ### Install -Install from PyPI with - +Install from conda with ```sh -python -m pip install glidertest +conda install --channel conda-forge glidertest ``` -Install a local, development version of this by cloning the repo, opening a terminal in the home directory (next to this readme file) and running these commands: +Install from PyPI with ```sh -pip install -r requirements-dev.txt -pip install -e . +python -m pip install glidertest ``` -This installs glidertest locally. -e ensures that any edits you make in the files will be picked up by scripts that import functions from glidertest. ### Documentation -Documentation website at [https://callumrollo.github.io/glidertest/](https://callumrollo.github.io/glidertest/) +Documentation is available at [https://callumrollo.github.io/glidertest/](https://callumrollo.github.io/glidertest/) -Check out the example notebook `notebooks/demo.ipynb` for example functionality +Check out the demo notebook `notebooks/demo.ipynb` for example functionality. As input, glidertest takes [OceanGliders format files](https://github.com/OceanGlidersCommunity/OG-format-user-manual) ### Contributing -All contributions are welcome! Please clone the repo and install a local development version of `glidertest` as described in the Install section above. All new functions should include tests, you can run the tests locally and generate a coverage report with: +All contributions are welcome! See [contributing](CONTRIBUTING.md) for more details + +To install a local, development version of glidertest, clone the repo, open a terminal in the root directory (next to this readme file) and run these commands: + +```sh +pip install -r requirements-dev.txt +pip install -e . +``` +This installs glidertest locally. -e ensures that any edits you make in the files will be picked up by scripts that import functions from glidertest. + +All new functions should include tests, you can run the tests locally and generate a coverage report with: ```sh pytest --cov=glidertest --cov-report term-missing tests/