Skip to content
This repository was archived by the owner on Mar 15, 2019. It is now read-only.

Commit 744f146

Browse files
committed
Update documentation
1 parent 5e65bee commit 744f146

File tree

2 files changed

+46
-1
lines changed

2 files changed

+46
-1
lines changed

docs/source/index.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
.. toctree::
44
:maxdepth: 2
55
:caption: Contents:
6-
6+
7+
installing
78
notebooks/overview.ipynb
89
notebooks/GLADE-cmip5_database.ipynb
910
api

docs/source/installing.rst

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
Installing
2+
==========
3+
4+
You can install intake-cmip with ``pip``, ``conda``, or by installing from source.
5+
6+
Pip
7+
---
8+
9+
Pip can be used to install intake-cmip::
10+
11+
pip install intake-cmip
12+
13+
Conda
14+
-----
15+
16+
To install the latest version of intake-cmip from the
17+
`conda-forge <https://conda-forge.github.io/>`_ repository using
18+
`conda <https://www.anaconda.com/downloads>`_::
19+
20+
conda install -c conda-forge intake-cmip
21+
22+
Install from Source
23+
-------------------
24+
25+
To install intake-cmip from source, clone the repository from `github
26+
<https://github.com/NCAR/intake-cmip>`_::
27+
28+
git clone https://github.com/NCAR/intake-cmip.git
29+
cd intake-cmip
30+
pip install .
31+
32+
You can also install directly from git master branch::
33+
34+
pip install git+https://github.com/NCAR/intake-cmip
35+
36+
37+
Test
38+
----
39+
40+
Test intake-cmip with ``pytest``::
41+
42+
git clone https://github.com/NCAR/intake-cmip.git
43+
cd intake-cmip
44+
pytest - v

0 commit comments

Comments
 (0)