pywrdrb.parameters#

Parameters are used to define operations within the pywrdrb model.

NYC Reservoir Releases#

Used to calculate NYC reservoir releases based on minimum daily release requirements and flood conditions, prior to accounting for Montague or other downstream releases. Assumes NYC reservoirs have equal percentage storage.

NYCCombinedReleaseFactor

Calculates the release factor for an NYC reservoir based on drought level and storage rule logic.

NYCFloodRelease

Computes excess flood control release for NYC reservoirs based on storage thresholds.

VolBalanceNYCDemand

Computes NYC reservoir delivery targets to meet downstream demands while balancing relative storage across the system.

NYC and NJ Diversions#

Used to keep track of annual average NYC and NJ diversions, which is limited by regulations.

FfmpNycRunningAvgParameter

Enforces the NYC FFMP delivery constraint using a running average over time.

FfmpNjRunningAvgParameter

Enforces NJ FFMP delivery limits using a drought-adjusted running average.

Flexible Flow Management Program (FFMP)#

Used to implement various aspects of the FFMP including minimum required flow (MRF) at Montague, and other excess release quantity banks.

TotalReleaseNeededForDownstreamMRF

Calculates the total NYC FFMP releases required to meet downstream Montague or Trenton flow targets.

VolBalanceNYCDownstreamMRF_step1

Assigns release targets for all 3 NYC reservoirs, above and beyond individual mandated releases, to meet Montague & Trenton MRF targets.

VolBalanceNYCDownstreamMRF_step2

Calculates the volume of additional flow that Neversink Reservoir must release during Step 2 of the staggered MRF coordination process, accounting for prior contributions and constraints.

LowerBasinMaxMRFContribution

Used to track the max of allowable release from a lower basin reservoir based on policy and current conditions.

VolBalanceLowerBasinMRFAggregate

Calculates total Trenton contribution from all lower basin reservoirs.

VolBalanceLowerBasinMRFIndividual

Distributes Trenton contributions among individual lower basin reservoirs.

IERQRelease_step1

Tracks the Interim Excess Release Quantity (IERQ) release for the Trenton bank.

STARFIT Reservoir Operations#

Used to determine reservoir release volume for STARFIT reservoirs.

STARFITReservoirRelease

STARFIT reservoir release parameter for non-NYC reservoirs.

Temperature LSTM Prediction#

Used to predict and track water temperature at Lordville using an LSTM model. Currently, no thermal control policy is implemented.

Salt Front LSTM Prediction#

Used to predict and track the salt front location in the lower basin using an LSTM model.

Ensemble Specific#

Used to handle ensemble simulation data, accounting for specific subsets of realizations.

FlowEnsemble

This parameter provides access to inflow ensemble timeseries.

PredictionEnsemble

Loads and stored ensemble of prediction timeseries used to inform NYC releases during simulation.

General#

General purpose parameters.

LaggedReservoirRelease

Computes historical release using rolling averages of outflow and spill from past timesteps.