Welcome to Pywr’s documentation!

Pywr is a generalised network resource allocation model written in Python. It intends to be fast, free and extendible.

Contents:

• Installing Pywr
  • Dependencies
  • Installing (in general)
  • Installing binary wheels with pip
  • Installing binary packages with Anaconda
  • Installing from source with Anaconda
  • Installing on Windows
  • Installing on Linux
  • Installing on OS X
  • Development and testing
• Tutorial
  • A minimal example
• Problem formulation
• JSON model format
  • Overview of document structure
  • Metadata
  • Timestepper
  • Solver
  • Nodes
  • Edges
  • Parameters
  • Loading a JSON document
  • Debugging and syntax errors
  • Footnotes
• GLPK error handling and performance
  • Version 1.17 and above
  • Older versions
• Cookbook
  • Demand restrictions
  • External data
  • Aggregated parameters
  • Aggregated nodes
  • Control curves
• Extending Pywr
  • Extending nodes
  • Extending parameters
  • Extending recorders
• Python API reference
  • Core classes
  • Nodes
  • Optimisation
  • Parameters
  • Recorders
  • Solvers
  • Notebook Utilities
  • Utilities
• License
  • Software
  • Documentation
  • Citation