Installation

Sloop

Sloop sources are available on gitlab: https://gitlab.com/GitShom/STM/sloop

First, create an account on Gitlab, and ask for an access to the repositiory, then put your ssh keys on your account.

Once done, clone the repository:

$ git clone git@gitlab.com:GitShom/STM/sloop.git

Then, update your environment variables as, for instance:

$ export PYTHONPATH="${PYTHONPATH}:/where/my/src/is/sloop/"

$ export PATH="${PATH}:/where/my/src/is/sloop/bin"

Sloop-deps

The following python packages are required to use sloop:

vortex	A software package designed to run simple to complex numerical workloads an a large variety of systems, from MeteoFrance.
configobj	ConfigObj is a simple but powerful config file reader and writer: an ini file round tripper.
matplotlib	Matplotlib is a comprehensive library for creating static, animated, and interactive visualizations in Python.
scipy	Scipy provides many user-friendly and efficient numerical routines, such as routines for numerical integration, interpolation, optimization, linear algebra, and statistics.
xarray	xarray is an open source project and Python package that makes working with labelled multi-dimensional arrays simple, efficient, and fun!
xoa	xoa is intended to help reading and manipulating observed and simulated ocean data. It is heavily based on xarray.

It is also required to have a Fortran compiler, MPI, and the NetCDF library.

Mots of these requirements are installable with the conda package manager.

A complete list of deps is available in environment.yml located in the env/ directory.

The Vortex library can be installed by cloning its git repository:

$ git clone git@gitlab.com:GitShom/STM/vortex.git

Then, update your environement variables as, for instance:

$ export PYTHONPATH="${PYTHONPATH}:/where/my/src/is/vortex/src:/where/my/src/is/vortex/site:/where/my/src/is/vortex/project"

$ export PATH="${PATH}:/where/my/src/is/vortex/bin"