Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

update readme with new install and test info #60

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

update readme with new install and test info #60

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 6 additions & 12 deletions README.rst
View file
Open in desktop
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
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should add metar in this and keep the conda-forge specification

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

since we are testing against pip install metar and there are no fancy dependency binaries, why would we advise users to install via conda and/or conda-forge?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it seems that where projects can be pure pip, they should be and the tests prove that users don't need conda-forge to make this work.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I kind of see what you mean, but the partial list of dependencies (missing metar) feels off to me. In my corner of the python world, people conda are now mostly installing via miniforge for mambaforge, where the defaults channel is omitted from .condarc as that's going to a subscription model.

Easiest thing would be to drop conda instructions entirely.


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:/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