sloop

Initialise and run a configuration

usage: sloop [-h] [--log-level {debug,info,warning,error,critical}]
             [--log-file LOG_FILE] [--log-no-color] [--novortex] [--skipic]
             [--config CONFIG]
             {info,init,check,config,constants,compile,run,archive,oper,fetch,clear}
             ...

Positional Arguments

mysub

Possible choices: info, init, check, config, constants, compile, run, archive, oper, fetch, clear

sub-command help

Named Arguments

--log-level

Possible choices: debug, info, warning, error, critical

logging level

Default: “info”

--log-file

logging file name

Default: “sloop.log”

--log-no-color

suppress colors in console

Default: False

--novortex

don’t use Vortex to create job

Default: False

--skipic

skip ibc_init job

Default: False

--config, -c

Config file with all user parameters croco.cfg

Default: “config_croco.cfg”

Sub-commands

info

show sloop info

See sloop info

sloop info [-h] [--exp-dir EXP_DIR]
           [{all,sloop_paths,versions,template_dir,exp_info}]

Positional Arguments

category

Possible choices: all, sloop_paths, versions, template_dir, exp_info

info category

Default: “all”

Named Arguments

--exp-dir: experiment directory

init

initialise a configuration

See sloop init

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

Named Arguments

-w, --work-dir

directory where to initialise your configuration

Default: .

-n, --dry-run

show what gonna be done without doing it, for testing purpose

Default: False

--develop

create symbolic links instead of copies, for development purpose

Default: False

--sloop-env

Possible choices: current, oper

which python sloop environment to be used for executing sloop executable

Default: “current”

--vortex-dir

vortex directory

--hpc-target

Possible choices: generic, datarmor, aquarium, meteofrance

HPC target

check

check various things

See sloop check

sloop check [-h] {exp-dir,env-vars,jobs,promises} ...

Sub-commands

exp-dir

check experiment directory

sloop check exp-dir [-h] [--xpid XPID]

Named Arguments

--xpid: name of the experiment

env-vars

check environment variables

sloop check env-vars [-h] [--xpid XPID] [--vapp VAPP] [--task TASK]

Named Arguments

--xpid: name of the experiment
--vapp: vortex application, like hycom3d
--task: task name

jobs

check job status

sloop check jobs [-h]

promises

check task promises

sloop check promises [-h] [--cfg CFG] [--ascii ASCII] task

Positional Arguments

task: task name

Named Arguments

--cfg

configuration file

Default: “promises.cfg”

--ascii

name of the output ascii file

Default: “promises_warning.txt”

config

configuration

See sloop config

sloop config [-h] [--log-level {debug,info,warning,error,critical}]
             [--exp-dir EXP_DIR]
             {show,export_env_vars} ...

Named Arguments

--log-level

Possible choices: debug, info, warning, error, critical

logging level

Default: “error”

--exp-dir

experiment directory

Sub-commands

show

show current config

sloop config show [-h] [section] [option]

Positional Arguments

section: config section
option: config option

export_env_vars

export env variables as bash declarations

sloop config export_env_vars [-h] section [var_name]

Positional Arguments

section: config section
var_name: show only the variable’s content

example of usage in a terminal: eval $(sloop config export_env_vars compile_ibc)

constants

permanent model files

See sloop constants

sloop constants [-h] [--exp-dir EXP_DIR] [--namespace NAMESPACE]
                {get,get-novortex,put,store} ...

Named Arguments

--exp-dir: experiment directory
--namespace: force the vortex namespace

Sub-commands

get

get tarfile of model permanent files

sloop constants get [-h] directory [pack [pack ...]]

Positional Arguments

directory: directory where to untar files
pack: selected packs

get-novortex

get model permanent files in no-vortex context

sloop constants get-novortex [-h]

put

store tarfile of model permanent files in cache uget

sloop constants put [-h] [--tardir TARDIR] directory [pack [pack ...]]

Positional Arguments

directory: directory where files are
pack: selected packs

Named Arguments

--tardir

directory where where to build .tar file

Default: “constants”

store

store tarfile of model permanent files on archive system

sloop constants store [-h] [--cycle CYCLE] {push,pull} ...

Named Arguments

--cycle: cycle target

Sub-commands

push

push constants on an user archive system

sloop constants store push [-h]

pull

pull constants from an user archive

sloop constants store pull [-h]

compile

compile fortran codes

See sloop compile

sloop compile [-h] {ibc,model,spnudge,postprod,all}

Positional Arguments

what

Possible choices: ibc, model, spnudge, postprod, all

what to compile

Default: “all”

run

run task

sloop run [-h] [--rundate RUNDATE] [-b BEGINDATE] [-e ENDDATE]
          [--ncycle NCYCLE] [--freq FREQ] [-j JOB] [-w WORKFLOW]
          [--exp-dir EXP_DIR] [--nodependency NODEPENDENCY]
          [--res-xpid RES_XPID]
          [--res-type {hindcast_free,hindcast_spnudge,nrt,None}]

Named Arguments

--rundate

rundate of the experiment

-b, --begindate

begindate of the experiment

-e, --enddate

enddate of the experiment

--ncycle

number of cycle

--freq

number of days between two cycles

Default: 7

-j, --job

name of the job to be submitted

-w, --workflow

name of the workflow to be submitted

--exp-dir

experiment directory

--nodependency

True or False

Default: False

--res-xpid

path@location or xpid

--res-type

Possible choices: hindcast_free, hindcast_spnudge, nrt, None

hindcast or near real time chaine

archive

permanent model files

See sloop archive

sloop archive [-h] {add} ...

Sub-commands

add

add data to sloop_oper archive store

sloop archive add [-h] [--cfg-file CFG_FILE] [--archive-dir ARCHIVE_DIR]
                  vapp vconf {sloop,sloop-oper,vortex,repos,consts}

Positional Arguments

vapp

vortex vapp, like hycom3d

vconf

vortex vconf, like manga

pack

Possible choices: sloop, sloop-oper, vortex, repos, consts

selected pack

Named Arguments

--cfg-file

archive config file

Default: “archive.cfg”

--archive-dir

archive directory where to add files

Default: /Users/mcaillau

oper

sloop oper subcommand

See sloop oper

sloop oper [-h] vapp vconf rundate {pull,release} ...

Positional Arguments

vapp: vortex vapp, like hycom3d
vconf: vortex vconf, like manga
rundate: date of the run

Sub-commands

pull

sloop oper pull subcommand

sloop oper pull [-h] [--cfg-file CFG_FILE] {logs,consts}

Positional Arguments

what

Possible choices: logs, consts

what to pull from oper platform

Default: “logs”

Named Arguments

--cfg-file

oper config file

Default: “oper.cfg”

release

release flow data

sloop oper release [-h] [--kind {restart}] [--mode {spnudge1,spnudge2,spinup}]
                   [--exp-dir EXP_DIR]

Named Arguments

--kind

Possible choices: restart

what to release

Default: “restart”

--mode

Possible choices: spnudge1, spnudge2, spinup

mode to release

Default: “spinup”

--exp-dir

experiment directory

fetch

fetch model or postprod outputs

sloop fetch [-h] [--cfg-file CFG_FILE] [--begindate BEGINDATE]
            [--enddate ENDDATE]

Named Arguments

--cfg-file

configuration file

Default: “fetch.cfg”

--begindate

begindate: YYYYMMDD

Default: “20230322”

--enddate

enddate: YYYYMMDD

clear

clear directories

sloop clear [-h] {cache,job,croco}

Positional Arguments

what

Possible choices: cache, job, croco

what to clear