.. _installing:

Install xarray-topo
===================

Required dependencies
---------------------

- Python 3.5 or later.
- `numpy <http://www.numpy.org/>`__
- `xarray <http://xarray.pydata.org>`__ (0.10.0 or later)
- `numba <http://numba.pydata.org/>`__ (0.35.0 or later)

Optional dependencies
---------------------

For landscape evolution modeling
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- `xarray-simlab <http://xarray-simlab.readthedocs.io>`__ (0.2.0 or later)

Install using conda
-------------------

xarray-topo can be installed or updated using conda_::

  $ conda install xarray-topo -c conda-forge

This installs xarray-topo and all common dependencies, including
numpy and xarray.

xarray-topo conda package is maintained on the `conda-forge`_
channel.

.. _conda-forge: https://conda-forge.org/
.. _conda: https://conda.io/docs/

Install using pip
-----------------

You can also install xarray-topo and its required dependencies using
``pip``::

  $ pip install xarray-topo

Install from source
-------------------

Be sure you have the required dependencies (numpy and xarray)
installed first. You might consider using conda_ to install them::

    $ conda install xarray xarray-simlab 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 .

Import xarray-topo
------------------

To make sure that ``xarray-topo`` is correctly installed, try import it in a
Python console::

    >>> import xtopo