Skip to content

Commit

Permalink
Merge pull request #135 from callumrollo/callumrollo-patch-4
Browse files Browse the repository at this point in the history
[DOCS] Add conda install
  • Loading branch information
callumrollo authored Nov 21, 2024
2 parents 02a726e + 1f2a91b commit 0a43fc5
Showing 1 changed file with 17 additions and 10 deletions.
27 changes: 17 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/
Expand Down

0 comments on commit 0a43fc5

Please sign in to comment.