Skip to content

Commit

Permalink
Merge pull request #122 from zssherman/conda_docs
Browse files Browse the repository at this point in the history
DOC: Added Anaconda badges and added act-atmos conda-forge install info.
  • Loading branch information
AdamTheisen authored Sep 17, 2019
2 parents 9e8b364 + 1ca2f0a commit fe8c0a1
Showing 1 changed file with 47 additions and 1 deletion.
48 changes: 47 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,17 @@
Atmospheric Community Toolkit (ACT)
===================================

.. image:: https://img.shields.io/travis/ANL-DIGR/ACT.svg
|AnacondaCloud| |CondaDownloads|

|Travis|

.. |AnacondaCloud| image:: https://anaconda.org/conda-forge/act-atmos/badges/version.svg
:target: https://anaconda.org/conda-forge/act-atmos

.. |CondaDownloads| image:: https://anaconda.org/conda-forge/act-atmos/badges/downloads.svg
:target: https://anaconda.org/conda-forge/act-atmos/files

.. |Travis| image:: https://img.shields.io/travis/ANL-DIGR/ACT.svg
:target: https://travis-ci.org/ANL-DIGR/ACT

Package for connecting Atmospheric data users to the
Expand All @@ -29,6 +39,42 @@ Dependencies
* `pandas <https://pandas.pydata.org/>`_
* `dask <https://dask.org/>`_

Installation
~~~~~~~~~~~~

ACT can be installed a few different ways. One way is to install using pip.
When installing with pip, the ACT dependencies found in
`requirements.txt <https://github.com/ANL-DIGR/ACT/blob/master/requirements.txt>`_ will also be installed. To install using pip::

pip install act-atmos

The easiest method for installing ACT is to use the conda packages from
the latest release. To do this you must download and install
`Anaconda <https://www.anaconda.com/download/#>`_ or
`Miniconda <https://conda.io/miniconda.html>`_.
With Anaconda or Miniconda install, it is recommended to create a new conda
environment when using ACT or even other packages. To create a new
environment based on the `environment.yml <https://github.com/ANL-DIGR/ACT/blob/master/environment.yml>`_::

conda env create -f environment.yml

Or for a basic environment and downloading optional dependencies as needed::

conda create -n act_env -c conda-forge python=3.7 act-atmos

Basic command in a terminal or command prompt to install the latest version of
ACT::

conda install -c conda-forge act-atmos

To update an older version of ACT to the latest release use::

conda update -c conda-forge act-atmos

If you do not wish to use Anaconda or Miniconda as a Python environment or want
to use the latest, unreleased version of ACT see the section below on
**Installing from source**.

Installing from Source
~~~~~~~~~~~~~~~~~~~~~~

Expand Down

0 comments on commit fe8c0a1

Please sign in to comment.