README.md 1.15 KB
Newer Older
Clément Haëck's avatar
Clément Haëck committed
1 2
# submeso-color

Clément Haëck's avatar
Clément Haëck committed
3 4 5 6
Collocate submesoscale fronts to phytoplankton levels using satellite imagery

## Content

Clément Haëck's avatar
Clément Haëck committed
7
- Download: Scripts for downloading data
Clément Haëck's avatar
Clément Haëck committed
8
- lib: Reusable code. Scripts for defining databases
Clément Haëck's avatar
Clément Haëck committed
9 10 11
- Compute: Process data, compute diagnostics,... Each python script is accompanied
  by a shell script to set the python environnement and launch it. If not, ./launch_python.py
  can be used.
Clément Haëck's avatar
Clément Haëck committed
12 13
- Plots: Plotting scripts

14 15 16 17 18 19 20 21 22
## Setup

The environment variable `$SUBMESO_COLOR_CODE_DIR` must be defined and point to
this repository location.
Bash scripts will source the `setup_env.sh` file in it, which defines other necessary
variables, notably `$SUBMESO_COLOR_DATA_DIR` for the location of data and plots.
It also appends this repository to the `$PYTHONPATH` variable.
The organisation of `setup_env.sh` is left to the user.
An example is given which works on a personnal computer and on the [Ciclad](https://mesocentre.ipsl.fr/) cluster.
Clément Haëck's avatar
Clément Haëck committed
23

Clément Haëck's avatar
Clément Haëck committed
24

Clément Haëck's avatar
Clément Haëck committed
25
## Requirements
26 27 28 29 30

    python3.8
    numpy
    scipy
    xarray
Clément Haëck's avatar
Clément Haëck committed
31
    dask
Clément Haëck's avatar
Clément Haëck committed
32 33
    matplotlib
    netcdf4
34 35
    motuclient
    cftime
36
    shapely
Clément Haëck's avatar
Clément Haëck committed
37
    global-land-mask
38 39 40
    filefinder
    
A conda environment file is provided ([./env.yml](./env.yml))
Clément Haëck's avatar
Clément Haëck committed
41