diff --git a/README.rst b/README.rst index 35bca1c850..5aafd881a2 100644 --- a/README.rst +++ b/README.rst @@ -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 @@ -29,6 +39,42 @@ Dependencies * `pandas `_ * `dask `_ +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 `_ 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 `_ or +`Miniconda `_. +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 `_:: + + 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 ~~~~~~~~~~~~~~~~~~~~~~