Skip to content

Commit f90f191

Browse files
authored
add installation instructions (#30)
1 parent 9223246 commit f90f191

File tree

2 files changed

+37
-0
lines changed

2 files changed

+37
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ Without mplotutils | With mplotutils
1111

1212
The code to create the examples can be found in [docs/example.py](docs/example.py).
1313

14+
## Installation
15+
16+
See [docs/installation.md](docs/installation.md).
17+
1418
## Changelog
1519

1620
See [CHANGELOG.md](CHANGELOG.md).

docs/installation.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Installation
2+
3+
## Required dependencies
4+
5+
- Python (3.7 or later)
6+
- [numpy](http://www.numpy.org/) (1.17 or later)
7+
- [matplotlib](http://matplotlib.org/) (3.4 or later)
8+
- [cartopy](http://scitools.org.uk/cartopy/) (0.17 or later)
9+
10+
## Optional dependencies
11+
12+
- [xarray](http://xarray.pydata.org/) (0.15 or later)
13+
14+
## Instructions
15+
16+
mplotutils itself is a pure Python package, but its dependencies are not.
17+
The easiest way to get them installed is to use [conda](http://conda.io/) or [mamba](https://mamba.readthedocs.io/en/latest/).
18+
19+
```bash
20+
mamba install -c conda-forge cartopy xarray
21+
```
22+
23+
mplotutils is not available from pypi or conda-forge, therefore it needs to be installed using pip directly from github.
24+
25+
### Install development version
26+
27+
```bash
28+
pip install git+https://github.com/mathause/mplotutils
29+
```
30+
31+
### Install latest released version
32+
33+
Go to the [newest release on github](https://github.com/mathause/mplotutils/releases/latest), copy the URL of the `*.tar.gz` source file at the botton and then use pip to install it (i.e. `pip install ...`).

0 commit comments

Comments
 (0)