nwm-rte/docs/reference/python_cli_help__run_calibration.py.txt at development · NGWPC/nwm-rte · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
usage: run_calibration.py [-h] [-delscratch] [-delraw]
                          [-ofunc OBJECTIVE_FUNCTION]
                          [-optalgo OPTIMIZATION_ALGORITHM] [-n NPROCS]
                          [-g GAGE_ID GAGE_ID]
                          [-start CALIB_SIM_START] [-dur CALIB_SIM_DURATION]
                          [-evaldelay CALIB_EVAL_DELAYMENT]
                          [-validadvance VALID_SIM_ADVANCEMENT]
                          [-evalcurtail VALID_EVAL_CURTAILMENT]
                          [-fsrc {nwm,aorc}]
                          [-gdomain {CONUS,Alaska,Hawaii,Puerto_Rico,GL}]
                          [-fprovider {bmi,csv}] [-fstatic FORCING_STATIC_DIR]
                          [-wrkr WORKER_NAME] [-mf MODEL_FORMULATION_CLI_CSV]
                          [-rz MODEL_FORMULATION_CLI_ROOTZONE]

Script for building and running calibration realizations using historical / retrospective forcing.

options:
  -h, --help            show this help message and exit
  -delscratch, --delete_scratch_and_mesh_first
                        Delete scratch dir and ESMF mesh files before the run, which forces ESMF and NetCDF actions to occur.
  -delraw, --delete_forcing_raw_input_first
                        Delete contents of '/ngen-app/data/raw_input' before the run, which forces forcing data to be re-downloaded.
  -ofunc OBJECTIVE_FUNCTION, --objective_function OBJECTIVE_FUNCTION
                        Objective function for calibration. Default: Objective.kge
  -optalgo OPTIMIZATION_ALGORITHM, --optimization_algorithm OPTIMIZATION_ALGORITHM
                        Optimization algorithm for calibration. Default: Algorithm.dds
  -n NPROCS, --nprocs NPROCS
                        Replaces default value for nprocs (1) and subsequently the ParallelConfig instance that is passed to MSWM.
  -g GAGE_ID, --gage_id GAGE_ID GAGE_ID
                        Calibration gage ID. If not provided, then this default will be used: 01123000
  --hydrofab_file HYDROFAB_FILE
                        Path to local hydrofabric gpkg file. If provided, bypasses msw-mgr Icefabric API call.
  -start CALIB_SIM_START, --calib_sim_start CALIB_SIM_START
                        Start time for calibration. Default=2013-07-25 00:00:00,
  -dur CALIB_SIM_DURATION, --calib_sim_duration CALIB_SIM_DURATION
                        Duration of calibration, in days (provide integer). Default=2
  -evaldelay CALIB_EVAL_DELAYMENT, --calib_eval_delayment CALIB_EVAL_DELAYMENT
                        Pandas-style timedelta string. Default=0:00:00
  -validadvance VALID_SIM_ADVANCEMENT, --valid_sim_advancement VALID_SIM_ADVANCEMENT
                        Pandas-style timedelta string. Default=0:00:00
  -evalcurtail VALID_EVAL_CURTAILMENT, --valid_eval_curtailment VALID_EVAL_CURTAILMENT
                        Pandas-style timedelta string. Default=0:00:00
  -fsrc {nwm,aorc}, --forcing_source {nwm,aorc}
                        Source of forcing data. Default=aorc. Choices for calibration: ['nwm', 'aorc']
  -gdomain {CONUS,Alaska,Hawaii,Puerto_Rico,GL}, --global_domain {CONUS,Alaska,Hawaii,Puerto_Rico,GL}
                        Region of forcing data. Default=CONUS
  -fprovider {bmi,csv}, --forcing_provider {bmi,csv}
                        Forcing provider. Default=bmi
  -fstatic FORCING_STATIC_DIR, --forcing_static_dir FORCING_STATIC_DIR
                        Directory for static forcing files, used when forcing_provider is 'bmi'. Default=/ngen-app/data
  -wrkr WORKER_NAME, --worker_name WORKER_NAME
                        If provided, will be used as the worker name, instead of letting cal mgr choose a random worker name. Only allowed for Optimization Algorithm DDS, which uses single instances of ngen. Does not affect 'default' realization (which is not a calibration).
  -mf MODEL_FORMULATION_CLI_CSV, --model-formulation MODEL_FORMULATION_CLI_CSV
                        Provide this argument to specify a non-default model formulation.
                                The value should be a comma-separated string of models that make up the formulation.
                                Can be used in conjunction with ["-rz", "--root-zone"].
                                Default: noah-owp-modular,cfe-s.
  -rz MODEL_FORMULATION_CLI_ROOTZONE, --root-zone MODEL_FORMULATION_CLI_ROOTZONE
                        Provided value is converted to Boolean and passed as `cfe_aet_rootzone`.
                                The value should be either true/yes/1 or false/no/0.
                                Can be used in conjunction with ["-mf", "--model-formulation"].
                                Default: False.