Inherits object.
Public Member Functions | |
| def | Command (self) |
| def | CommandString (self) |
| def | SetMongoClient (self) |
| def | UnsetMongoClient (self) |
| def | ReadMongoDBData (self) |
| def | OutputIDs (self) |
| def | OutputItems (self) |
| def | ReadOutletObservations (self, vars_list) |
| def | SetOutletObservations (self, vars_list, vars_value) |
| def | ReadTimeseriesSimulations (self, stime=None, etime=None) |
| def | GetTimespan (self) |
| def | ParseTimespan (self) |
| def | ResetSimulationPeriod (self) |
| def | ResetOutputsPeriod (self, output_ids, stime, etime) |
| def | run (self, do_execute=True) |
| def | clean (self, scenario_id=None, calibration_id=None, delete_scenario=False, delete_spatial_gfs=False) |
| def | UpdateScenarioID (self) |
Main entrance to SEIMS model.
| def seims.run_seims.MainSEIMS.clean | ( | self, | |
scenario_id = None, |
|||
calibration_id = None, |
|||
delete_scenario = False, |
|||
delete_spatial_gfs = False |
|||
| ) |
Clean model outputs in OUTPUT<ScenarioID>-<CalibrationID> directory and/or
GridFS files in OUTPUT collection.
Examples:
model.SetMongoClient()
model.clean()
model.UnsetMongoClient()
| def seims.run_seims.MainSEIMS.Command | ( | self | ) |
Concatenate command (as a list) to run SEIMS-based model.
| def seims.run_seims.MainSEIMS.CommandString | ( | self | ) |
Concatenate commands list to one string.
| def seims.run_seims.MainSEIMS.GetTimespan | ( | self | ) |
Get summarized timespan, format is [IO, COMP, SIMU, RUNTIME].
| def seims.run_seims.MainSEIMS.OutputIDs | ( | self | ) |
Read output items from database.
| def seims.run_seims.MainSEIMS.OutputItems | ( | self | ) |
Read output items from database.
| def seims.run_seims.MainSEIMS.ParseTimespan | ( | self | ) |
The format of self.timespan is different for OpenMP version and MPI&OpenMP version.
For OpenMP version:
{'IO': {'Input': 0.2,
'Output': 0.04
}
'COMP': {'TSD_RD_P': 0.0001, # All modules
'ALL': 12.3
}
'SIMU': {'ALL': 14.1}
}
For MPI&OpenMP version:
{'MAX': {'IO': {'Input': 0.1,
'Output': 0.02,
'ALL': 0.12
}
'COMP': {'Slope': 5,
'Channel': 0.5,
'Barrier': 0.1,
'ALL': 5.6
}
'SIMU': {'ALL': 10.1}
}
'MIN': {...}
'AVG': {...}
}
| def seims.run_seims.MainSEIMS.ReadMongoDBData | ( | self | ) |
Examples:
model.SetMongoClient()
model.ReadMongoDBData()
model.UnsetMongoClient()
| def seims.run_seims.MainSEIMS.ReadOutletObservations | ( | self, | |
| vars_list | |||
| ) |
Examples:
model.SetMongoClient()
model.ReadOutletObservations()
model.UnsetMongoClient()
| def seims.run_seims.MainSEIMS.ReadTimeseriesSimulations | ( | self, | |
stime = None, |
|||
etime = None |
|||
| ) |
Read time series simulation results from OUTPUT directory. If no start time or end time are specified, the time ranges from `FILE_IN` will be used.
| def seims.run_seims.MainSEIMS.ResetOutputsPeriod | ( | self, | |
| output_ids, | |||
| stime, | |||
| etime | |||
| ) |
Reset the STARTTIME and ENDTIME of OUTPUTID(s).
Examples:
model.SetMongoClient()
model.clean()
model.UnsetMongoClient()
| def seims.run_seims.MainSEIMS.ResetSimulationPeriod | ( | self | ) |
Update simulation time range in MongoDB [FILE_IN].
Examples:
model.SetMongoClient()
model.ResetSimulationPeriod()
model.UnsetMongoClient()
| def seims.run_seims.MainSEIMS.run | ( | self, | |
do_execute = True |
|||
| ) |
Run SEIMS model
Examples:
model.SetMongoClient()
model.run()
model.UnsetMongoClient()
| def seims.run_seims.MainSEIMS.SetMongoClient | ( | self | ) |
Should be invoked outset of this script and followed by `UnsetMongoClient`
| def seims.run_seims.MainSEIMS.SetOutletObservations | ( | self, | |
| vars_list, | |||
| vars_value | |||
| ) |
Set observation data from the inputs.
| def seims.run_seims.MainSEIMS.UnsetMongoClient | ( | self | ) |
Should be invoked together with `SetMongoClient`
| def seims.run_seims.MainSEIMS.UpdateScenarioID | ( | self | ) |
This function should be simultaneously updated with `InputArgs` class in C++