.. Getting Started
   Author: Pieter De Vis
   Email: pieter.de.vis@npl.co.uk
   Created: 15/04/20

.. _getting_started:

Getting Started
===============

Dependencies
#############

matheo has the following dependencies:

* Python (3.7 or above)
* `numpy <https://numpy.org>`_
* `pyspectral <https://pyspectral.readthedocs.io/en/latest/>`_
* `comet_maths <https://comet-maths.readthedocs.io/en/latest/>`_
* `punpy <https://punpy.readthedocs.io/en/latest/>`_


Installation
#############

The easiest way to install matheo is using pip::

   $ pip install matheo

Ideally, it is recommended to do this inside a virtual environment (e.g. conda).

Alternatively, for the latest development version, first go to the folder where you want to save matheo and clone the project repository from GitHub::

   $ git clone git@github.com:meteor-toolkit/matheo.git

Then go into the created directory and install the module with pip::

   $ cd matheo
   $ pip install -e .