Install rfmpy
==============

`rfmpy` is currently at development and are subject to change
at any time. Also please note that, at least at this stage,
the codes are designed to reproduce our results.
For different applications the codes will need to be modified. The codes are only tested on *Linux OS*.

It is recommended to install `rfmpy` inside a Conda environment to
preserve your root environment. You can download Conda at the
following `link <https://docs.conda.io/en/latest/miniconda.html>`__.

Conda
~~~~~~~~~~~~
Once you have installed conda, open a terminal (Linux)
create a new environment with the following dependencies using:


.. code-block:: bash

   $ conda config --add channels conda-forge
   $ conda create -n rfmpy python=3.6 pip obspy=1.2.1 matplotlib numpy pandas basemap cartopy shapely fortran-compiler
   $ conda activate rfmpy
   $ conda install -c anaconda ipython=7.13


Install from source:

.. code-block:: bash

   $ git clone https://github.com/kemichai/rfmpy.git
   $ cd rfmpy

Once you clone the project open a terminal in the
top directory (the one containing setup.py) and type the
following to install the functions and make em available everywhere on your machine (within your environment).

.. code-block:: bash

   $ pip install .

This should be it! Before you leave if you also want to use the GMT scripts we use for making various maps see
below on how to install Generic Mapping Tools (GMT) in a separate conda environment.

.. note::
    Performed on *Ubuntu 20.04.1 LTS*, so it could differ for other OS.


GMT
~~~~~~~~~~~~
In case, you would like to run the gmt codes you can create a separate conda environment using the
commands bellow:

.. code-block:: bash

   $ conda create --name gmt6
   $ conda activate gmt6
   $ conda config --prepend channels conda-forge
   $ conda install python=3.9 gmt