Installation
============

.. highlight:: bash

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

shoot requires ``python>3`` and depends on the following packages:

.. list-table::
   :widths: 10 90

   * - `numpy <https://numpy.org/>`_
     - Numpy is a comprehensive library for scientific computation
   * - `numba <https://numba.pydata.org/>`_
     - A high performance python compiler.
   * - `scipy <https://www.scipy.org/scipylib/index.html>`_
     - Scipy provides many user-friendly and efficient numerical routines,
       such as routines for numerical integration, interpolation,
       optimization, linear algebra, and statistics.
   * - `xarray <http://xarray.pydata.org/en/stable/>`_
     - xarray is an open source project and Python package that makes working
       with labelled multi-dimensional arrays simple, efficient, and fun!
   * - `contourpy <https://pypi.org/project/contourpy/>`_
     - Contourpy is a library for computing contours on grids
   * - `gsw <https://teos-10.github.io/GSW-Python/>`_
     - Gsw is a package for thermodynamic equation of Seawater
   * - `matplotlib <https://matplotlib.org/>`_
     - Matplotlib is a comprehensive library for creating static, animated,
       and interactive visualizations in Python.
   * - `cartopy <https://scitools.org.uk/cartopy/docs/latest/>`_
     - Cartopy is a package for geospatial data processing


From sources
------------

Clone the repository::

    $ git clone https://github.com/shom-fr/shoot.git

Run the installation command from the root directory::

    $ cd shoot
    $ pip install .