@@ -18,24 +18,46 @@ For model visualization
1818
1919- `graphviz <http://graphviz.readthedocs.io >`__
2020
21- Install from source
21+ Install using conda
2222-------------------
2323
24- While there are ``xarray-simlab `` releases available at `PyPi `_ and
25- `conda-forge `_, you may prefer to install from source.
24+ xarray-simlab can be installed or updated using conda _::
25+
26+ $ conda install xarray-simlab -c conda-forge
27+
28+ This installs xarray-simlab and all common dependencies, including
29+ numpy and xarray.
30+
31+ xarray-simlab conda package is maintained on the `conda-forge `_
32+ channel.
33+
34+ .. _conda-forge : https://conda-forge.org/
35+ .. _conda : https://conda.io/docs/
36+
37+ Install using pip
38+ -----------------
39+
40+ You can also install xarray-simlab and its required dependencies using
41+ ``pip ``::
42+
43+ $ pip install xarray-simlab
44+
45+ Install from source
46+ -------------------
2647
27- Be sure you have the required dependencies (numpy and xarray)
28- installed first. You might consider using conda _ to install them::
48+ To install xarray-simlab from source, be sure you have the required
49+ dependencies (numpy and xarray) installed first. You might consider
50+ using conda _ to install them::
2951
3052 $ conda install xarray numpy pip -c conda-forge
3153
32- A good practice (especially for development purpose) is to install the packages
33- in a separate environment, e.g. using conda::
54+ A good practice (especially for development purpose) is to install the
55+ packages in a separate environment, e.g. using conda::
3456
3557 $ conda create -n simlab_py36 python=3.6 xarray numpy pip -c conda-forge
3658 $ source activate simlab_py36
3759
38- Then you can clone the `` xarray-simlab `` git repository and install it
60+ Then you can clone the xarray-simlab git repository and install it
3961using ``pip `` locally::
4062
4163 $ git clone https://github.com/benbovy/xarray-simlab
@@ -47,13 +69,11 @@ For development purpose, use the following command::
4769 $ pip install -e .
4870
4971.. _PyPi : https://pypi.python.org/pypi/xarray-simlab/
50- .. _conda-forge : https://github.com/conda-forge/xarray-simlab-feedstock
51- .. _conda : http://conda.io/
5272
5373Import xarray-simlab
5474--------------------
5575
56- To make sure that `` xarray-simlab `` is correctly installed, try to import it by
57- running this line::
76+ To make sure that xarray-simlab is correctly installed, try to import
77+ it by running this line::
5878
5979 $ python -c "import xsimlab"
0 commit comments