Skip to content

Commit 69b40a7

Browse files
committed
Add conda install instructions
1 parent bd5bbfc commit 69b40a7

File tree

2 files changed

+40
-15
lines changed

2 files changed

+40
-15
lines changed

INSTALL.rst

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,28 @@
11
Installation
22
============
33

4-
To install or upgrade ProPlot:
4+
ProPlot can be installed with `pip <https://pypi.org>`__ or `conda <https://anaconda-project.readthedocs.io/en/latest/>`__:
55

66
.. code-block:: bash
77
8-
pip install -U proplot
8+
pip install proplot
99
10-
If you previously used ``pip install git+https://github.com/lukelbd/proplot.git``
11-
to install a development version of proplot,
12-
please run ``pip uninstall proplot`` first.
10+
.. code-block:: bash
11+
12+
conda install -c conda-forge proplot
13+
14+
An existing installation of ProPlot can be upgraded to the latest version with:
15+
16+
.. code-block:: bash
17+
18+
pip install --upgrade proplot
19+
20+
.. code-block:: bash
21+
22+
conda upgrade proplot
23+
24+
25+
If you used ``pip install git+https://github.com/lukelbd/proplot.git`` to install ProPlot before it was released on PyPi, you may need to run ``pip uninstall proplot`` before upgrading.
26+
To install a development version of ProPlot, you can use this same method, or clone the repository and run ``pip install --upgrade .`` inside the ``proplot`` folder.
1327

1428
ProPlot's only hard dependency is `matplotlib <https://matplotlib.org/>`__. The *soft* dependencies are `cartopy <https://scitools.org.uk/cartopy/docs/latest/>`__, `basemap <https://matplotlib.org/basemap/index.html>`__, `xarray <http://xarray.pydata.org>`__, and `pandas <https://pandas.pydata.org>`__. See the documentation for details.

README.rst

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,25 +5,36 @@
55

66
A comprehensive, easy-to-use `matplotlib <https://matplotlib.org/>`__ wrapper for making beautiful, publication-quality graphics.
77

8-
Documentation
9-
=============
10-
The documentation is `published on readthedocs <https://proplot.readthedocs.io>`__.
11-
128
Installation
139
============
1410

15-
To install or upgrade ProPlot:
11+
ProPlot can be installed with `pip <https://pypi.org>`__ or `conda <https://anaconda-project.readthedocs.io/en/latest/>`__:
1612

1713
.. code-block:: bash
1814
19-
pip install -U proplot
15+
pip install proplot
2016
17+
.. code-block:: bash
18+
19+
conda install -c conda-forge proplot
20+
21+
An existing installation of ProPlot can be upgraded to the latest version with:
22+
23+
.. code-block:: bash
2124
22-
If you previously used ``pip install git+https://github.com/lukelbd/proplot.git``
23-
to install a development version of proplot,
24-
please run ``pip uninstall proplot`` first.
25+
pip install --upgrade proplot
2526
26-
ProPlot's only hard dependency is `matplotlib <https://matplotlib.org/>`__. The *soft* dependencies are `cartopy <https://scitools.org.uk/cartopy/docs/latest/>`__, `basemap <https://matplotlib.org/basemap/index.html>`__, `xarray <http://xarray.pydata.org>`__, and `pandas <https://pandas.pydata.org>`__. See the documentation for details.
27+
.. code-block:: bash
28+
29+
conda upgrade proplot
30+
31+
32+
If you used ``pip install git+https://github.com/lukelbd/proplot.git`` to install ProPlot before it was released on PyPi, you may need to run ``pip uninstall proplot`` before upgrading.
33+
To install a development version of ProPlot, you can use this same method, or clone the repository and run ``pip install --upgrade .`` inside the ``proplot`` folder.
34+
35+
Documentation
36+
=============
37+
The documentation is `published on readthedocs <https://proplot.readthedocs.io>`__.
2738

2839

2940
.. |code-style| image:: https://img.shields.io/badge/code%20style-pep8-green.svg

0 commit comments

Comments
 (0)