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

.. _getting_started:

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

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

**comet_maths** has the following dependencies:

* Python (3.7 or above)
* `numpy <https://numpy.org>`_
* `scipy <https://scipy.org>`_
* `sklearn <https://scikit-learn.org/>`_
* `matplotlib <https://matplotlib.org/>`_
* `numdifftools <https://numdifftools.readthedocs.io/en/latest/>`_
* `punpy <https://punpy.readthedocs.io/en/latest/>`_

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

The easiest way to install **comet_maths** is using pip::

   $ pip install comet_maths

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 **comet_maths** and clone the project repository from GitHub::

   $ git clone git@github.com:comet-toolkit/comet_maths.git

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

   $ cd comet_maths
   $ pip install -e .