Contents & Architecture

3. Contents & Architecture#

3.1. Architecture#

A classical work architecture consists in:

croco/croco
croco/croco_tools
croco/croco_pytools
CONFIGS

To run a CROCO simulation, you need to follow these 3 steps:

  • complete the pre-processing (for realistic cases) => see Pre-processing tutorials using Matlab (croco_tools) or Python (croco_pytools)

  • set-up the parameters and setting files (param.h and cppdefs.h) and compiled the model

  • set-up the input file croco.in and run the model

CROCO contents, main inputs and setting files are described in the following:

3.2. Contents of CROCO source code#

CROCO and its tools are distributed in separate repositories croco, croco_tools for Matlab version and croco_pytools for Python version.

The croco repository contains the model itself with the following directories :

AGRIF

Agrif library for nesting

BENCH

Testing script

CVTK

Regression test library

MPI_NOLAND

Fortran utility to determine the optimal MPI decomposition to supress land computation

MUSTANG

MUSTANG sediment model source files

OBSTRUCTION

OBSTRUCTION module source files

OCEAN

CROCO source files

PISCES

PISCES biogeochemical model source files

README.md

Informations on CROCO version

SCRIPTS

Scripts for plurimonth runs, online analysis tools, and coupled simulations

TEST_CASES

Test cases namelists and useful files

XIOS

XIOS I/O server library

create_config.bash
Script to setup your configuration. It creates a configuration directory,
and copy useful files in it from croco, croco_tools and
croco_pytools sources
Contents