diff --git a/README.rst b/README.rst index a3a9a58..410a651 100644 --- a/README.rst +++ b/README.rst @@ -30,3 +30,19 @@ Tools for working with earth system multi-model analyses with xarray. See documentation_ for more information. .. _documentation: https://esmlab.readthedocs.io/en/latest/ + +Installation +------------ + +ESMLab can be installed from PyPI with pip: + +.. code-block:: bash + + pip install esmlab + + +It is also available from `conda-forge` for conda installations: + +.. code-block:: bash + + conda install -c conda-forge esmlab diff --git a/docs/source/install.rst b/docs/source/install.rst index 863c01d..89bba3f 100644 --- a/docs/source/install.rst +++ b/docs/source/install.rst @@ -27,7 +27,7 @@ To install esmlab from source, clone the repository from `github git clone https://github.com/NCAR/esmlab.git cd esmlab - pip install . + pip install -e . You can also install directly from git master branch:: @@ -37,8 +37,8 @@ You can also install directly from git master branch:: Test ---- -Test esmlab with ``pytest``:: +To run esmlab's tests with ``pytest``:: git clone https://github.com/NCAR/esmlab.git cd esmlab - pytest - v \ No newline at end of file + pytest - v