nwm-rte/docs/reference/python_cli_help__run_forecast.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
usage: run_forecast.py [-h] [-delscratch] [-delraw]
                       [-ofunc OBJECTIVE_FUNCTION]
                       [-optalgo OPTIMIZATION_ALGORITHM] [-g GAGE_ID]
                       [-gdomain {CONUS,Alaska,Hawaii,Puerto_Rico,GL}]
                       [-fstatic FORCING_STATIC_DIR] [-fprov FORCING_PROVIDER]
                       -dt CYCLE_DATETIME [-csdt COLD_START_DATETIME]
                       [-le LAGGED_ENSEMBLE_ARGS LAGGED_ENSEMBLE_ARGS LAGGED_ENSEMBLE_ARGS]
                       [-fconfig FORCING_CONFIGURATION] [-rname FCST_RUN_NAME]
                       [-n NPROCS]

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 of previously-ran calibration realization for basis of forecast. Affects directory path. Default: Objective.kge
  -optalgo OPTIMIZATION_ALGORITHM, --optimization_algorithm OPTIMIZATION_ALGORITHM
                        Optimization algorithm of previously-ran calibration realization for basis of forecast. Affects directory path. Default: Algorithm.dds
  -g GAGE_ID, --gage_id GAGE_ID
                        Gage ID to run the forecast for. Default: '01123000'
  -gdomain {CONUS,Alaska,Hawaii,Puerto_Rico,GL}, --global_domain {CONUS,Alaska,Hawaii,Puerto_Rico,GL}
                        Global domain/region of forcing data. Default=CONUS
  -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
  -fprov FORCING_PROVIDER, --forcing_provider FORCING_PROVIDER
                        Forcing provider to use, e.g., 'bmi' or 'csv'. Default: 'bmi'
  -dt CYCLE_DATETIME, --cycle_datetime CYCLE_DATETIME
                        For a regular forecast, this is the start time. When cold-start is used, this is the *end* of the cold-start cycle. Format: 'YYYY-MM-DD HH:mm:ss'.
  -csdt COLD_START_DATETIME, --cold_start_datetime COLD_START_DATETIME
                        If provided, a cold-start realization will be ran prior to the forecast, and this value will be the start time for the cold-start. Format: 'YYYY-MM-DD HH:mm:ss'.
  -le LAGGED_ENSEMBLE_ARGS LAGGED_ENSEMBLE_ARGS LAGGED_ENSEMBLE_ARGS, --lagged-ensemble LAGGED_ENSEMBLE_ARGS LAGGED_ENSEMBLE_ARGS LAGGED_ENSEMBLE_ARGS
                        Provide this multi-part argument to run one member of a lagged ensemble (see nwm-fcst-mgr function `run_lagged_ensemble`).
                                Only applicable to the "medium_range" forcing configuration.
                                Not applicable to the cold-start realization.

                                To run an ensemble, call this script multiple times with varying values for this argument, e.g. for "mem1", "mem2", etc.

                                This argument has 3 parts:
                                    1. member_name : str (required when -le provided)
                                        Name of the ensemble member. Choose from: ['no_da', 'mem1', 'mem2', 'mem3', 'mem4', 'mem5', 'mem6']
                                    2. open_loop_state : str (optional)
                                        Path to an existing open-loop state file.
                                        To omit, provide an empty string for this part.
                                    3. closed_loop_state : str (optional)
                                        Path to an existing closed-loop state file.
                                        To omit, provide an empty string for this part.

                                To run a lagged ensemble member without the optional parts, provide them as empty strings e.g. `-le 'mem2' '' ''`.

  -fconfig FORCING_CONFIGURATION, --forcing_configuration FORCING_CONFIGURATION
                        Forcing configuration to use, e.g., 'short_range', 'standard_ana', etc. Default: 'short_range'
  -rname FCST_RUN_NAME, --fcst_run_name FCST_RUN_NAME
                        Forecast run name. Default: 'fcst_run1'
  -n NPROCS, --nprocs NPROCS
                        Replaces default value for nprocs (1) and subsequently the ParallelConfig instance that is passed to MSWM.