Skip to content

Commit

Permalink
add conda badge and conda installation instructions (#87)
Browse files Browse the repository at this point in the history
  • Loading branch information
bradyrx committed Jul 9, 2020
1 parent 4beb080 commit d5c682a
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 3 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.rst
Expand Up @@ -9,6 +9,7 @@ Internals/Minor Fixes
---------------------
- Fix ``flake8`` F401 error by using ``TimeUtilAccessor`` directly in first instance
in code. (:pr:`86`) `Riley X. Brady`_.
- Add ``conda`` badge and ``conda`` installation instructions. (:pr:`87`) `Riley X. Brady`_.

esmtools v1.1.1 (2020-07-08)
============================
Expand Down
21 changes: 19 additions & 2 deletions README.rst
Expand Up @@ -8,6 +8,10 @@ a toolbox for Earth System Model analysis
.. image:: https://img.shields.io/pypi/v/esmtools.svg
:target: https://pypi.python.org/pypi/esmtools/

.. image:: https://img.shields.io/conda/vn/conda-forge/esmtools.svg
:target: https://anaconda.org/conda-forge/esmtools
:alt: Conda Version

.. image:: https://coveralls.io/repos/github/bradyrx/esmtools/badge.svg?branch=master
:target: https://coveralls.io/github/bradyrx/esmtools?branch=master

Expand All @@ -22,9 +26,22 @@ a toolbox for Earth System Model analysis
Installation
============

You can install the latest release of ``esmtools`` using ``pip``.
We will also release ``esmtools`` on conda for the next release.
You can install the latest release of ``esmtools`` using ``pip`` or ``conda``:

.. code-block:: bash
pip install esmtools
.. code-block:: bash
conda install -c conda-forge esmtools
You can also install the bleeding edge (pre-release versions) by cloning this
repository and running ``pip install . --upgrade`` in the main directory.

Documentation
=============

Documentation is in development and can be found on readthedocs_.

.. _readthedocs: https://esmtools.readthedocs.io/en/stable/
16 changes: 15 additions & 1 deletion docs/source/index.rst
Expand Up @@ -8,6 +8,10 @@ esmtools: a toolbox for Earth system model analysis
.. image:: https://img.shields.io/pypi/v/esmtools.svg
:target: https://pypi.python.org/pypi/esmtools/

.. image:: https://img.shields.io/conda/vn/conda-forge/esmtools.svg
:target: https://anaconda.org/conda-forge/esmtools
:alt: Conda Version

.. image:: https://coveralls.io/repos/github/bradyrx/esmtools/badge.svg?branch=master
:target: https://coveralls.io/github/bradyrx/esmtools?branch=master

Expand Down Expand Up @@ -36,12 +40,22 @@ datetimes on the independent (x) axis:
Installation
============

You can install the latest release of ``esmtools`` using ``pip``:
You can install the latest release of ``esmtools`` using ``pip`` or ``conda``:

.. code-block:: bash
pip install esmtools
.. code-block:: bash
conda install -c conda-forge esmtools
You can also install the bleeding edge (pre-release versions) by running

.. code-block:: bash
pip install git+https://github.com/bradyrx/esmtools@master --upgrade
**Getting Started**

* :doc:`examples`
Expand Down

0 comments on commit d5c682a

Please sign in to comment.