msm_Project

tables.auto_generated.msm_Project

Classes

Name Description
msm_ProjectTable Table for msm_Project (Simulation setup).
msm_ProjectTableColumns Column names for msm_Project (Simulation setup).

msm_ProjectTable

tables.auto_generated.msm_Project.msm_ProjectTable(net_table)

Table for msm_Project (Simulation setup).

Attributes

Name Description
columns Get the columns for the table.
description Get the table description.
display_name Get the display name for the table.
name Get the table name.

Methods

Name Description
delete Create a DELETE query for this table.
get_muids Get a list of MUIDs for the table.
insert Insert a row with the given values.
select Create a SELECT query for this table.
update Create an UPDATE query for this table.
delete
tables.auto_generated.msm_Project.msm_ProjectTable.delete()

Create a DELETE query for this table.

Returns
Name Type Description
DeleteQuery A new DeleteQuery object
get_muids
tables.auto_generated.msm_Project.msm_ProjectTable.get_muids(
    order_by=None,
    descending=False,
)

Get a list of MUIDs for the table.

Parameters
Name Type Description Default
order_by str or None Column to order the MUIDs by None
descending bool Whether to order in descending order False
Returns
Name Type Description
list of str A list of MUIDs
insert
tables.auto_generated.msm_Project.msm_ProjectTable.insert(values, execute=True)

Insert a row with the given values.

Parameters
Name Type Description Default
values dict of str to Any Column-value pairs to insert required
execute bool Whether to execute the query immediately (default: True) True
Returns
Name Type Description
str or InsertQuery If execute is True, returns the ID of the newly inserted row (MUID) If execute is False, returns an InsertQuery instance
select
tables.auto_generated.msm_Project.msm_ProjectTable.select(columns=[])

Create a SELECT query for this table.

Parameters
Name Type Description Default
columns list of str The columns to select []
Returns
Name Type Description
SelectQuery A new SelectQuery object
update
tables.auto_generated.msm_Project.msm_ProjectTable.update(values)

Create an UPDATE query for this table.

Parameters
Name Type Description Default
values dict of str to Any Column-value pairs to set in the UPDATE required
Returns
Name Type Description
UpdateQuery A new UpdateQuery object

msm_ProjectTableColumns

tables.auto_generated.msm_Project.msm_ProjectTableColumns(table)

Column names for msm_Project (Simulation setup).

Attributes

Name Description
ADInitCondID AD initial condition ID
ADInitCondTypeNo Type
ADPNetworkFileName Additional parameters filename
ADPNetworkFileNo Apply Additional Parameters
ADPRunoffFileName ADP filename
ADPRunoffFileNo Use ADP File
ActiveProject Active simulation
CDDt Catchment discharge [sec]
ComputationBegin Start
ComputationEnd End
DecouplingADHDTypeNo Decoupling of HD and AD simulations
DecouplingPath Decoupling file
Description Description
DistribTypeNo Distribution type
DtDryPeriod Dry weather [sec]
DtWetPeriod Wet weather [sec]
ELIntegrationNo MIKE ECO Lab Integration
ELUpdateFrequency MIKE ECO Lab update frequency
Enable_2DOverland 2D Overland
Enable_AD Transport (AD, SWQ)
Enable_CD Catchment discharge (CD)
Enable_CS Collection system network
Enable_Catchment Catchments
Enable_DA Data assimilation (DA)
Enable_ECOLAB Water quality (MIKE ECO Lab)
Enable_HD Hydrodynamic (HD)
Enable_LTS Long term statistics (LTS)
Enable_M21FM_Coupling Coupling to MIKE 21 or MIKE 3 FM
Enable_MHRiver_Coupling Coupling to MIKE HYDRO River
Enable_RR Rainfall-Runoff (RR)
Enable_River River network
Enable_ST Sediment transport (ST)
HDDtFixed Fixed [sec]
HDDtIncreaseFactor Max. increase factor
HDDtMax Maximum [sec]
HDDtMin Minimum [sec]
HDFolderPath Result folder path
HDInitCondID Initial conditions ID
HDInitCondTypeNo Type
HDOutputNo Save results in default/this folder
HDTimeStepType Time step
IncludeToBatchNo Include to batch
KWDt Kin. wave [sec]
M2DADDtMax Maximum [sec]
M2DADDtMin Minimum [sec]
M2DADMaxCFL Max. CFL number [()]
M2DHDMaxCFL Max. CFL number [()]
MJLFileName LTS Job List
MUID ID
Power Power parameter
RDIHotStartFileName RDII HotStart filename
RDIHotStartNo Use RDII HotStart
RDIHotStartTime RDI hot start time
RDIHotStartTimeUseNo Use simulation start time
SRCDt RDI [h]
ScenarioName Scenario
SearchRadius Maximum search radius [km]
Sqn Sqn
StateFilesFolder State files folder
StateStartTime Date and time
SummaryID Network summary
TADt Time-Area [sec]
UHMDt UHM [sec]
UseSimulationTypeNo Select state file using simulation start time