diff --git a/README.rst b/README.rst index dd8912851..1e5065889 100644 --- a/README.rst +++ b/README.rst @@ -15,11 +15,19 @@ Siphon .. image:: https://img.shields.io/pypi/v/siphon.svg :target: https://pypi.python.org/pypi/siphon/ - :alt: Latest Version + :alt: PyPI Package .. image:: https://img.shields.io/pypi/dm/siphon.svg :target: https://pypi.python.org/pypi/siphon/ - :alt: Downloads + :alt: PyPI Downloads + +.. image:: https://binstar.org/unidata/siphon/badges/version.svg + :target: https://binstar.org/unidata/siphon + :alt: Binstar Package + +.. image:: https://binstar.org/unidata/siphon/badges/downloads.svg + :target: https://binstar.org/unidata/siphon + :alt: Binstar Downloads .. image:: https://travis-ci.org/Unidata/siphon.svg?branch=master :target: https://travis-ci.org/Unidata/siphon diff --git a/docs/source/developerguide.rst b/docs/source/developerguide.rst index 94cec69c1..0e368c37a 100644 --- a/docs/source/developerguide.rst +++ b/docs/source/developerguide.rst @@ -13,6 +13,21 @@ Requirements - IPython >= 3.1 - pandoc (not a python package) +~~~~~ +Conda +~~~~~ + +Settings up a development environment in Siphon is as easy as (from the +base of the repository): + +.. parsed-literal:: + conda env create + conda develop -n devel . + +The ``environment.yml`` contains all of the configuration needed to easily +set up the environment, called ``devel``. The second line sets up conda to +run directly out of the git repository. + -------------- Making Changes -------------- diff --git a/environment.yml b/environment.yml new file mode 100755 index 000000000..192c491c6 --- /dev/null +++ b/environment.yml @@ -0,0 +1,19 @@ +# Create full conda environment for development, including some useful tools +name: devel +channels: + - https://conda.binstar.org/Unidata +dependencies: + - python=3 + - numpy + - scipy + - matplotlib + - pint + - requests + - protobuf + - netcdf4 + - ipython-notebook + - sphinx + - nose + - vcrpy + - flake8 + - pep8-naming