StateDMI / Command / SetWellHistoricalPumpingTSMonthlyConstant
Overview
The SetWellHistoricalPumpingTSMonthlyConstant
command (for StateCU and StateMod)
sets well historical pumping time series (monthly) data to a constant value.
The output period can be set or will default to that defined by the most recent
SetOutputPeriod
command.
Command Editor
The following dialog is used to edit the command and illustrates the command syntax.
SetWellHistoricalPumpingTSMonthlyConstant
Command Editor (see also the full-size image)
Command Syntax
The command syntax is as follows:
SetWellHistoricalPumpingTSMonthlyConstant(Parameter="Value",...)
Command Parameters
Parameter | Description | Default |
---|---|---|
ID required |
A single well station identifier to match or a pattern using wildcards (e.g., 20* ). |
None – must be specified. |
Constant |
A constant historical value to set. | None – must be specified. |
SetStart |
The start of the period for the set, in a standard date/time format for monthly data (e.g., YYYY-MM or MM/YYYY ). |
The output period start. |
SetEnd |
The end of the period for the set, in a standard date/time format for monthly data (e.g., YYYY-MM or MM/YYYY ). |
The output period end. |
RecalcLimits |
If True , then the time series limits will be recalculated as if the provided values are observations. If False , the limits from before the set will remain. |
True |
IfNotFound |
Used for error handling, one of the following:
|
Warn |
Examples
See the automated tests.
Troubleshooting
See Also
FillWellHistoricalPumpingTSMonthlyAverage
commandFillWellHistoricalPumpingTSMonthlyConstant
commandFillWellHistoricalPumpingTSMonthlyPattern
commandSetOutputPeriod
commandSetWellHistoricalPumpingTSMonthly
command