Skip to content
WaterStrategy Documentation
Search
Ctrl
K
Cancel
Select theme
Dark
Light
Auto
Menu
Getting Started
Creating an Account
Logging In
Tour of WaterStrategy
Creating a new Project and Network
Sharing Projects and Networks
Exporting and Importing Models
Dealing with Model Errors
Uploading External Data
Modeling Basics
Water Resource System Modeling?
What is Pywr?
Pywr Concepts
node-types
Node Types
water-input
Water Input
Input Node
Catchment Node
Proportional Input Node
water-transport
Water Transport
Link Node
River Node
Delay Node
RiverSplit Node
RiverSplitWithGauge Node
RiverGauge Node
BreakLink Node
PiecewiseLink Node
MultiSplitLink Node
water-storage
Water Storage
Storage Node
Reservoir Node
VirtualStorage Node
RollingVirtualStorage Node
AnnualVirtualStorage Node
SeasonalVirtualStorage Node
AggregatedStorage Node
water-output
Water Output
Output Node
Loss Link Node
hydropower
Hydropower
Turbine Node
others
Others
AggregatedNode
Allocation Penalties
scenarios
Scenarios
WaterStrategy Scenarios
pywr-scenarios
Pywr-Scenarios
Parameter and pywr-scenario Integration
parameters
Parameters
base-parameter-class
Base Parameter Class
Parameter
IndexParameter
simple-parameters
Simple Parameters
Constant
Constant Scenario Parameter
Constant Scenario Index Parameter
combining-multiple-parameters
Combining multiple parameters
Aggregated Parameter
Aggregated Index Parameter
Division Parameter
Negative Parameter
MaxParameter
Negative MaxParameter
MinParameter
Negative MinParameter
Offset Parameter
time-series-and-profiles
Time Series and Profiles
Daily Profile
Weekly Profile
Monthly Profile
Uniform Drawdown Profile
Scenario Daily Profile
Scenario Weekly Profile
Scenario Monthly Profile
Array Indexed Scenario Monthly Factors
RBF Profile
DataFrame Parameter
HDF5 Parameter
array-based-parameters
Array Based Parameters
Array Indexed Parameter
Array Indexed Scenario Parameter
Indexed Array Parameter
threshold-parameters
Threshold Parameters
Abstract Threshold
Storage Threshold
Node Threshold
Parameter Threshold
Recorder Threshold
Current Year Threshold
Current Ordinal Day Threshold
interpolation-parameters
Interpolation Parameters
Interpolated Parameter
Interpolated Quadrature
Interpolated Flow
Interpolated Volume
control-curve-parameters
Control Curve Parameters
Base Control Curve
Control Curve Interpolated Parameter
Control Curve Piecewise Interpolated Parameter
Control Curve Index Parameter
Hydropower Parameters
others
Others
Annual Harmonic Series Parameter
Deficit Parameter
Scenario Wrapper Parameter
Piecewise Integral Parameter
Flow Parameter
Flow Delay Parameter
Discount Factor Parameter
recorders
Recorders
base-recorder
Base Recorder
Recorder
Node Recorder
Storage Recorder
Parameter Recorder
Index Parameter Recorder
Aggregator
numpy-array-recorders
Numpy Array Recorders
Numpy Array Node Recorder
Numpy Array Storage Recorder
Numpy Array Level Recorder
Numpy Array Area Recorder
Numpy Array Parameter Recorder
Numpy Array Index Parameter Recorder
Numpy Array Daily Profile Parameter Recorder
flow-duration-curve-recorders
Flow Duration Curve Recorders
Flow Duration Curve Recorder
Storage Duration Curve Recorder
Flow Duration Curve Deviation Recorder
Seasonal Flow Duration Curve Recorder
deficit-recorders
Deficit Recorders
Numpy Array Node Deficit Recorder
Numpy Array Node Supplied Ratio Recorder
Numpy Array Node Curtailment Ratio Recorder
Total Deficit Node Recorder
Deficit Frequency Node Recorder
statistical-recorders
Statistical Recorders
Aggregated Recorder
Mean Flow Node Recorder
Total Flow Node Recorder
Annual Total Flow Recorder
Mean Parameter Recorder
Total Parameter Recorder
Rolling Mean Flow Node Recorder
Minimum Volume Storage Recorder
Minimum Threshold Volume Storage Recorder
Timestep Count Index Parameter Recorder
Annual Count Index Threshold Recorder
Rolling Window Parameter Recorder
index-recorders
Index Recorders
Annual Count Index Parameter Recorder
file-recorders
File Recorders
CSV Recorder
Tables Recorder
hydro-power-recorders
Hydro-power Recorders
Hydropower Recorder
Total Hydro Energy Recorder
Applied Modeling
Reservoir and Storage Nodes
Tutorials
creating-and-running-a-simple-model
Creating and running a simple model
creating-and-running-a-model
Creating and Running a Model
Setting up a Project and Network
Adding Nodes and Links (Edges)
Add Data to the Nodes
Setting the Time Horizon
Running the Model and Visualizing its Outputs
Creating a New Scenario
Using a Monthly Profile in a New Scenario
Exercise
making-changes-to-a-model
Making Changes to a Model
Adding a Reservoir
Adding Basic Operating Rules
creating-a-reservoir-system
Modelling basin reservoir systems
Creating a New Project and Network
Adding a Dam (Reservoir)
Adding a Demand
Adding a Water Treatment Works with Losses
Adding a Source Representing Groundwater
Additional Exercises
adding-reservoir-details
Adding reservoir bathymetry, evaporation, and rainfall
Background on Evaporation and Precipitation on Reservoirs
Adding reservoir bathymetry (Area)
Adding reservoir bathymetry (Level)
Adding monthly evaporation and rainfall
Using allocation penalties and control rules to balance sources
control-curves-and-demand-savings
Control Curves and Demand Savings
Adding reservoir control curves and demand savings (reductions)
using-allocation-penalties
Using Allocation Penalties to Allocate Water
Exercise 1a Two nodes
Exercise 1b Two demands
Exercise 1c Minimum Flow Properties
Exercise 2a Simple system with reservoir draw downs
Exercise 2b Simple system with overflow
pywr-scenarios-reading-external-dataframe-and-adding-custom-rules
Pywr-scenarios reading external DataFrame and adding Custom Rules
Uploading Files
Reading CSV DataFrame
Running pywr-scenarios
Reading h5 DataFrame for pywr-scenarios
Create Custom Rule - TranscientDecisionParameter
Support
Select theme
Dark
Light
Auto
Base Parameter Class
All the
Parameter
subclasses in
pywr
are descended from a common base class.