pyDeltaRCM.preprocessor.Preprocessor

class pyDeltaRCM.preprocessor.Preprocessor(input_file=None, **kwargs)

Python high level api.

This is the python high-level API class that is callable from a python script. For complete documentation on the API configurations, see the User Guide.

The class gives a way to configure and run multiple jobs from a python script.

Examples

To configure a set of jobs (or a single job), instantiate the python preprocessor and then manually run the configured jobs:

>>> pp = preprocessor.Preprocessor(input_file=p, timesteps=500)
>>> pp.run_jobs()
__init__(input_file=None, **kwargs)

Initialize the python 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.

You must specify timesteps in either the YAML configuration file or via the timesteps parameter.

Parameters
  • input_file (str, optional) – Path to an input YAML configuration file. Must include the timesteps parameter if you do not specify the timesteps as a keyword argument.

  • timesteps (int, optional) – Number of timesteps to run each of the jobs. Must be specified if you do not specify the timesteps parameter in the input YAML file.

Methods

__init__([input_file])

Initialize the python 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.

run_jobs([DeltaModel])

Run the set of jobs.

Attributes

config_list

Configuration list.

file_list

File list.

job_list

Job list.