3. Sloop init : Setup a working directory

This command is described here 2. Initialisation

It builds the experiment directory and link sloop and vortex sources directories.

Note

This command has to be launched only once !

Arguments

$ sloop init --help
usage: sloop init [-h] [-w WORK_DIR] [-n] [--develop]
                  [--sloop-env {current,oper}] [--vortex-dir VORTEX_DIR]
                  [--hpc-target {generic,datarmor,aquarium,meteofrance}]
                  vapp vconf xpid

positional arguments:
  vapp                  vortex vapp, like ``hycom3d``
  vconf                 vortex vconf, like ``manga``
  xpid                  vortex xpid, a kind of experiment, in the format
                        ``myexp@location``, where ``location`` defaults to
                        username

optional arguments:
  -h, --help            show this help message and exit
  -w WORK_DIR, --work-dir WORK_DIR
                        directory where to initialise your configuration
  -n, --dry-run         show what gonna be done without doing it, for testing
                        purpose
  --develop             create symbolic links instead of copies, for
                        development purpose
  --sloop-env {current,oper}
                        which python sloop environment to be used for
                        executing sloop executable
  --vortex-dir VORTEX_DIR
                        vortex directory
  --hpc-target {generic,datarmor,aquarium,meteofrance}
                        HPC target

Usage

$ sloop init croco med demo@$USER -n
[32msloop.cli.main: [1mINFO    [1m[0m[32m Work directory: /Users/mcaillau/Documents/ETUDES/PROJET_MED/SRC_CODE/sloop/doc[0m
[32msloop.cli.main: [1mINFO    [1m[0m[32m Experiment dir: /Users/mcaillau/Documents/ETUDES/PROJET_MED/SRC_CODE/sloop/doc/demo@$USER/croco/med[0m
[32msloop.cli.main: [1mINFO    [1m[0m[32m Created directory: /Users/mcaillau/Documents/ETUDES/PROJET_MED/SRC_CODE/sloop/doc/demo@$USER/croco/med[0m
[32msloop.cli.main: [1mINFO    [1m[0m[32m /Users/mcaillau/Documents/libs/miniconda3/envs/sloop/bin/python will be used by sloop[0m
[31msloop.cli.main: [1mERROR   [1m[0m[31m You must provide the vortex directory with the  --vortex option[0m

Note

The “-n” just show the output but does nothing , don’t forget to remove it

What to do on Datarmor

On datarmor you could do that

sloop init croco med test@$USER --vortex $SRC_DIR/vortex

Warning

don’t forget to load your environment ! (see env)

Then, your experiment directory should look like this :abbr: