seims.run_seims.ParseSEIMSConfig Class Reference

Inherits object.

Detailed Description

Parse SEIMS model related configurations from `ConfigParser` object.

Attributes:
    host (str): MongoDB IP address
    port (int): MongoDB port number
    bin_dir (str): Executable dir of SEIMS. Spaces and unicode characters are not allowed
    model_dir (str): Model dir which contains essential data and configs for running a model
    db_name (str): Name of main database stored in MongoDB, default is dirname of `model_dir`
    version (str): Version of SEIMS main program, can be `MPI` or `OMP` (default)
    mpi_bin (str): Path of MPI executable file, e.g., /usr/bin/mpirun
    hosts_opt (str): (Optional) Key to specify hostfile for MPI version,
                      e.g., `-f`, `-hostfile`, `-machine`, `-machinefile`
    hostfile (str): File containing hostnames or file mapping process numbers to computing nodes
    nprocess (int): Process number of MPI, i.e., how many MPI tasks will be executed
    npernode (int): Launch num processes per node on all allocated computing nodes
    flag_npernode (string): Flag to specify NPERNODE, e.g., -ppn for common MPI implementation
    nthread (int): Thread number of OpenMP, i.e., how many threads of each processes
    fdirmtd (int): Flow direction method for flow routing, default is 0 (D8),
                    can also be 1 (DINF) and 2 (MFDMD)
    lyrmtd (int): Method of creating routing layers of simulation units,
                    can be 0 (UP_DOWN) and 1 (DOWN_UP)
    scenario_id (int): Scenario ID
    calibration_id (int): Calibration ID
    subbasin_id (int): Subbasin ID, 0 for the entire basin, 1-N for subbasin,
                         9999 for SEIMS-field version
    simu_stime (datetime): Start time of simulation (UTCTIME), the format is YYYY-MM-DD HH:MM:SS
    simu_etime (datetime): End time of simulation (UTCTIME), the format is YYYY-MM-DD HH:MM:SS
    out_stime (datetime): Start time of output data (UTCTIME)
    out_etime (datetime): End time of output data (UTCTIME)
    workload (str): Use workload manager to run multiple models simultaneously, e.g., Slurm
    config_dict (dict): Dict of all configurations
    runtime (float): Running time counted by `time.time()` of Python,
                       in case of `GetTimespan()` failed

The documentation for this class was generated from the following file: