.. _installing:
Install xarray-topo
===================
Required dependencies
---------------------
- Python 3.4 or later.
- `numpy `__
- `xarray `__ (0.8.0 or later)
- `numba `__ (0.29.0 or later)
Optional dependencies
---------------------
For landscape evolution modeling
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- `xarray-simlab `__
Install from source
-------------------
There is currently no ``xarray-topo`` release available at PyPi_
or conda-forge_.
Be sure you have the required dependencies (numpy and xarray)
installed first. You might consider using conda_ to install them::
$ conda install xarray numba numpy pip -c conda-forge
A good practice (especially for development purpose) is to install the packages
in a separate environment, e.g. using conda::
$ conda create -n topo_py36 python=3.6 xarray numba numpy pip -c conda-forge
$ source activate topo_py36
Then you can clone the ``xarray-topo`` git repository and install it
using ``pip`` locally::
$ git clone https://gitext.gfz-potsdam.de/sec55-public/xarray-topo
$ cd xarray-topo
$ pip install .
For development purpose, use the following command::
$ pip install -e .
.. _PyPi: https://pypi.python.org/pypi
.. _conda-forge: https://conda-forge.github.io/
.. _conda: http://conda.io/
Import xarray-topo
------------------
To make sure that ``xarray-topo`` is correctly installed, try import it in a
Python console::
>>> import xtopo