pyDeltaRCM.preprocessor.PreprocessorCLI

class pyDeltaRCM.preprocessor.PreprocessorCLI

Command line preprocessor.

This is the main CLI class that is called from the command line. The class defines a method to process the arguments from the command line (using the argparse package).

Note

You probably do not need to interact with this class directly. Instead, you can use the command line API as it is described in the User Guide or the python API Preprocessor.

When the class is called from the command line the instantiated object’s method run_jobs() is called by the preprocessor_wrapper function that the CLI (entry point) calls directly.

__init__() → None

Initialize the CLI preprocessor.

The initialization includes the entire configuration of the job list (parsing, timesteps, etc.). The jobs are not run automatically during instantiation of the class.

Methods

__init__()	Initialize the CLI preprocessor.
construct_file_list()	Construct the file list.
open_input_file_to_dict(input_file)	Open an input file and convert it to a dictionary.
process_arguments()	Process the command line arguments.
run_jobs([DeltaModel])	Run the set of jobs.

Attributes

config_list	Configuration list.
file_list	File list.
job_list	Job list.

process_arguments() → Dict[str, float] | Dict[str, int]

Process the command line arguments.

Note

The command line args are not directly passed to this function in any way.