Docker-in-Docker (DinD) capabilities of public runners deactivated. More info

README.md 1.14 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
- Compute: Process data, compute diagnostics,... 
Clément Haëck's avatar
Clément Haëck committed
10 11
- Plots: Plotting scripts

12 13 14 15 16 17 18 19 20
## 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
21

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

Clément Haëck's avatar
Clément Haëck committed
23
## Requirements
24 25

    python3.8
Clément Haëck's avatar
Clément Haëck committed
26 27 28 29 30 31 32 33 34 35 36 37 38 39
        -numpy
        -scipy
        -pandas
        -xarray
        -dask
        -matplotlib
        -netcdf4
        -motuclient
        -cftime
        -shapely
        -global-land-mask
        -filefinder
    
- [dateloop](https://github.com/Descanonge/dateloop)
40 41
    
A conda environment file is provided ([./env.yml](./env.yml))
Clément Haëck's avatar
Clément Haëck committed
42