Skip to content

Commit

Permalink
Merge pull request #60 from austinorr/update-readme
Browse files Browse the repository at this point in the history
update readme with new install and test info
  • Loading branch information
phobson authored Dec 17, 2024
2 parents cc177c1 + 9549567 commit 567619b
Showing 1 changed file with 6 additions and 12 deletions.
18 changes: 6 additions & 12 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -104,36 +104,30 @@ If you're using `environments <http://conda.pydata.org/docs/intro.html>`_
managed through ``conda`` (recommended), this will
get you started: ::

conda create --name=cloudside python=3.6 notebook pytest pandas matplotlib requests coverage

Followed by: ::

conda activate cloudside
conda install metar --channel=conda-forge
conda create --name=cloudside python=3.8 notebook pytest pandas matplotlib requests coverage

Installation
------------

* Activate your ``conda`` environment;
* Install via pip and git; and
* Activate your ``conda`` environment
* Install via pip

::

conda activate cloudside
pip install git+https://github.com/Geosyntec/cloudside.git

pip install cloudside

Testing
-------

Tests are run via ``pytest``. Run them all with: ::

source activate cloudside # (omit "source" on Windows)
python -c "import cloudside; cloudside.test()"
pytest

Documentation
-------------
We have `HTML docs built with sphinx <http://geosyntec.github.io/cloudside/>`_.
We have forthcoming `HTML docs built with sphinx <http://geosyntec.github.io/cloudside/>`_.

Development status
------------------
Expand Down

0 comments on commit 567619b

Please sign in to comment.