fatiando/rockhound

.. _install:

Installing
==========

Which Python?
-------------

You'll need **Python 3.6 or greater**.

We recommend using the
`Anaconda Python distribution <https://www.anaconda.com/download>`__
to ensure you have all dependencies installed and the ``conda`` package manager
available.
Installing Anaconda does not require administrative rights to your computer and
doesn't interfere with any other Python installations in your system.


Dependencies
------------

* `pooch <http://www.fatiando.org/pooch/>`__
* `xarray <https://xarray.pydata.org/>`__
* `pandas <https://pandas.pydata.org>`__
* `rasterio <https://rasterio.readthedocs.io>`__
* `dask <https://dask.org/>`__

Most of the examples in the :ref:`gallery` also use:

* `matplotlib <https://matplotlib.org/>`__
* `cmocean <https://matplotlib.org/cmocean/>`__ for beautiful colormaps
* `cartopy <https://scitools.org.uk/cartopy/>`__ for plotting maps


Installing with conda
---------------------

You can install RockHound using the `conda package manager <https://conda.io/>`__ that
comes with the Anaconda distribution::

    conda install rockhound --channel conda-forge


Installing with pip
-------------------

Alternatively, you can also use the `pip package manager
<https://pypi.org/project/pip/>`__::

    pip install rockhound


Installing the latest development version
-----------------------------------------

You can use ``pip`` to install the latest source from Github::

    pip install https://github.com/fatiando/rockhound/archive/master.zip

Alternatively, you can clone the git repository locally and install from there::

    git clone https://github.com/fatiando/rockhound.git
    cd rockhound
    pip install .


Testing your install
--------------------

We ship a full test suite with the package.
To run the tests, you'll need to install some extra dependencies first:

* `pytest <https://docs.pytest.org/>`__

After that, you can test your installation by running the following inside a Python
interpreter::

    import rockhound
    rockhound.test()