This release is a pre-release and may not be stable for production use.
Pywr-next
This is repository contains the current work-in-progress for the next major revision to
Pywr. It uses Rust as a backend instead of Cython. It
is currently not ready for use beyond development and experimentation. Comments and discussions are welcome.
User Guide
·
Report Bug
·
Request Feature
Table of Contents
About The Project
Pywr-1.x is a Python library which utilises Cython for performance. Over time this has resulted in a "core" set of data structures and objects that are written in Cython to gain maximum performance. Cython has the nice benefit of making it easy to extend that core functionality using regular Python. However, the border between what is Python and what is Cython is a bit blurred and not well designed in certain places.
One option for the future development of Pywr (e.g. Pywr-2.x) would be a more explicit separation between the compute "core" and higher level functionality. Rust is a candidate for writing that core largely independent of Python, and possibly offers the benefits of (1) greater performance than Cython, and (2) easier maintenance in the future.
Requirements
Any major revision to Pywr will have the following feature requirements:
- Retain the "Parameter" system from Pywr-1.x - this is core functionality that makes Pywr really flexible.
- Extendable in Python space.
- An improved approach for outputting data and metrics.
- Better error handling.
- Cross-platform.
- Faster!
- Strong input file (JSON) schema.
Built With
Getting started
Installing pre-compiled wheels
See instructions in the Pywr book.
Compiling from source
This repository contains a version of Clp using Git submodules. In order to build those submodules must be initialised first.
git submodule init
git submodule update
Rust is required for installation of the Python extension. To create a Python development installation requires first compiling the Rust library and then the Python extension. The following example uses a virtual environment to install the Python dependencies, compile the Pywr extension and run the Pywr Python CLI.
python -m venv .venv # create a new virtual environment
source .venv/bin/activate # activate the virtual environment (linux)
# .venv\Scripts\activate # activate the virtual environment (windows)
pip install maturin # install maturin for building the Python extension
maturin develop # compile the Pywr Python extension
python -m pywr # run the Pywr Python CLI
Usage
Rust CLI
A basic command line interface is included such that you can use this version of Pywr without Python.
This CLI is in the pywr-cli crate.
To see the CLI commands available run the following:
cargo run -p pywr-cli -- --help
To run a Pywr v2 model use the following:
cargo run -p pywr-cli -- run tests/models/simple1.json
Python CLI
If the Python extension has been compiled using the above instructions a model can be run using the basic Python CLI.
python -m pywr run tests/models/simple1.json
Porting a Pywr v1.x model to v2.x
This version of Pywr is not backward compatible with Pywr v1.x. One of the major reasons for this version is the lack of a strong schema in the Pywr v1.x JSON files. Pywr v2.x uses an updated JSON schema that is defined in this repository. Therefore, v1.x JSON files must be converted to the v2.x JSON schema. This conversion can be undertaken manually, but there is also a work-in-progress conversion tool. The conversion tool uses a v1.x schema defined in the pywr-schema project.
Please note that conversion from Pywr v1.x to v2.x is experimental and not all features of Pywr are implemented
in pywr-schema or have been implemented in Pywr v2.x yet. Due to the changes between these versions it is very
likely an automatic conversion will not completely convert your model, and it WILL require manual testing and
checking.
cargo run --no-default-features -- convert /path/to/my/v1.x/model.json
Feedback on porting models is very welcome, so please open an issue with any questions or problems.
Crates
This repository contains the following crates:
Pywr-core
A low-level Rust library for constructing network models. This crate interfaces with linear program solvers.
Feature flags:
| Feature | Description | Default |
|---|---|---|
pyo3 |
Enable the Python bindings. | True |
highs |
Enable the HiGHS LP solver. | False |
ipm-ocl |
Enable the OpenCL IPM solver (requires nightly). | False |
ipm-simd |
Enable the AVX IPM solver (requires nightly). | False |
cbc |
Enable the CBC MILP solver. | False |
Pywr-schema
A Rust library for validating Pywr JSON files against a schema, and then building a model from the schema
using pywr-core.
Feature flags:
| Feature | Description | Default |
|---|---|---|
core |
Enable building models from the schema with pywr-core. This feature is enabled by default, but requires a lot of dependencies. If you only require schema validation and manipulation consider building this crate with default-features = false |
True |
pyo3 |
Enable the Python bindings. | True |
highs |
Enable the HiGHS LP solver. | False |
ipm-ocl |
Enable the OpenCL IPM solver (requires nightly). | False |
ipm-simd |
Enable the AVX IPM solver (requires nightly). | False |
cbc |
Enable the CBC MILP solver. | False |
Pywr-cli
A command line interface for running Pywr models.
Pywr-python
A Python extension (and package) for constructing and running Pywr models.
Roadmap
- Proof-of-concept - demonstrate the benefits of the RIIR approach.
- Redesign of outputs & metrics.
- Redesign of variable API for integration with external optimisation algorithms.
- Implement outstanding
Parametersfrom Pywr v1.x - Design & implement Python API using Rust extension.
- Release Pywr v2.x beta
See the open issues for a full list of proposed features (and known issues).
Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
License
Distributed under the Apache 2.0 or MIT License. See LICENSE.txt for more information.
Contact
James Tomlinson - tomo.bbe@gmail.com
Project Link: https://github.com/pywr/pywr-next
Copyright (C) 2020-2023 James Tomlinson Associates Ltd.
1 maintainer
Metadata
1 maintainer
Release files for pywr 2.0.0b6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distributions (wheels)
| File | Reset | |||
|---|---|---|---|---|
| pywr-2.0.0b6-cp314-cp314t-win_amd64.whl | CPython 3.14 | CPython 3.14 free-threading | Windows x86-64 | Details |
| pywr-2.0.0b6-cp314-cp314t-manylinux_2_28_x86_64.whl | CPython 3.14 | CPython 3.14 free-threading | Linux glibc 2.28+ x86-64 | Details |
| pywr-2.0.0b6-cp314-cp314t-macosx_11_0_arm64.whl | CPython 3.14 | CPython 3.14 free-threading | macOS 11.0+ ARM64 | Details |
| pywr-2.0.0b6-cp314-cp314t-macosx_10_12_x86_64.whl | CPython 3.14 | CPython 3.14 free-threading | macOS 10.12+ x86-64 | Details |
| pywr-2.0.0b6-cp310-abi3-win_amd64.whl | CPython 3.10 | abi3 | Windows x86-64 | Details |
| pywr-2.0.0b6-cp310-abi3-manylinux_2_28_x86_64.whl | CPython 3.10 | abi3 | Linux glibc 2.28+ x86-64 | Details |
| pywr-2.0.0b6-cp310-abi3-macosx_11_0_arm64.whl | CPython 3.10 | abi3 | macOS 11.0+ ARM64 | Details |
| pywr-2.0.0b6-cp310-abi3-macosx_10_12_x86_64.whl | CPython 3.10 | abi3 | macOS 10.12+ x86-64 | Details |
Total release size: 169.6 MB
Release files / pywr-2.0.0b6-cp314-cp314t-win_amd64.whl
| Download URL | pywr-2.0.0b6-cp314-cp314t-win_amd64.whl |
|---|---|
| Size | 21.6 MB |
| Tags | CPython 3.14 CPython 3.14 free-threading Windows x86-64 |
|
SHA-256 checksum How to use checksums |
01481afbab98c555158433c8f4998368560a65a2f39def137a4be4573b2c5eed
|
|
BLAKE2b-256 checksum How to use checksums |
1b264dd2a909245e6c12cae8bdccf0795a19a918c0955fe9ebf05f0dd51869bb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 25, 2026.
Transparency logRelease files / pywr-2.0.0b6-cp314-cp314t-manylinux_2_28_x86_64.whl
| Download URL | pywr-2.0.0b6-cp314-cp314t-manylinux_2_28_x86_64.whl |
|---|---|
| Size | 22.7 MB |
| Tags | CPython 3.14 CPython 3.14 free-threading Linux glibc 2.28+ x86-64 |
|
SHA-256 checksum How to use checksums |
ca5946810c6b2351368af6e518b745c2f6043b23950b29ac7d355520c9a9bc78
|
|
BLAKE2b-256 checksum How to use checksums |
b5a1b0e40ae512333d0052419ec9ed2ae4575ce9d4031ad740736a314c69c809
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 25, 2026.
Transparency logRelease files / pywr-2.0.0b6-cp314-cp314t-macosx_11_0_arm64.whl
| Download URL | pywr-2.0.0b6-cp314-cp314t-macosx_11_0_arm64.whl |
|---|---|
| Size | 19.6 MB |
| Tags | CPython 3.14 CPython 3.14 free-threading macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
6ed4b9a1e479b454aedac50cbe8ab2a4a30d0846ef67b23b2d6c96ea324b31c7
|
|
BLAKE2b-256 checksum How to use checksums |
1e9b2f0485b3e1f5b51dbb4b7b003907231768f59ef0f8008ac73ed6ec312ec5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 25, 2026.
Transparency logRelease files / pywr-2.0.0b6-cp314-cp314t-macosx_10_12_x86_64.whl
| Download URL | pywr-2.0.0b6-cp314-cp314t-macosx_10_12_x86_64.whl |
|---|---|
| Size | 20.8 MB |
| Tags | CPython 3.14 CPython 3.14 free-threading macOS 10.12+ x86-64 |
|
SHA-256 checksum How to use checksums |
b82f5587468789820430a2b6c20d70b5c25f0806fd5e662ed2349efa4a32eb1d
|
|
BLAKE2b-256 checksum How to use checksums |
29f69575c9b901d1bb431c3429da56145452cc1a30339236b372ac6a4f9a9b8f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 25, 2026.
Transparency logRelease files / pywr-2.0.0b6-cp310-abi3-win_amd64.whl
| Download URL | pywr-2.0.0b6-cp310-abi3-win_amd64.whl |
|---|---|
| Size | 21.7 MB |
| Tags | CPython 3.10 Windows x86-64 abi3 |
|
SHA-256 checksum How to use checksums |
9fedc1382bdc951d30fe5e367c6a536dfdec6ea2406d36b908039979c50e8d0f
|
|
BLAKE2b-256 checksum How to use checksums |
73df9d79a6d2fba2c84e67ffc0992fb118ea3c216334e082712af5172335df90
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 25, 2026.
Transparency logRelease files / pywr-2.0.0b6-cp310-abi3-manylinux_2_28_x86_64.whl
| Download URL | pywr-2.0.0b6-cp310-abi3-manylinux_2_28_x86_64.whl |
|---|---|
| Size | 22.8 MB |
| Tags | CPython 3.10 Linux glibc 2.28+ x86-64 abi3 |
|
SHA-256 checksum How to use checksums |
65a5c409edc6ac5445f299949a9fffa421a696a52fc7cf01a68b4cd8b181d72e
|
|
BLAKE2b-256 checksum How to use checksums |
cb326a948211fa4804ab81afb88ab1604d077432f4e459581c46a1da26004f06
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 25, 2026.
Transparency logRelease files / pywr-2.0.0b6-cp310-abi3-macosx_11_0_arm64.whl
| Download URL | pywr-2.0.0b6-cp310-abi3-macosx_11_0_arm64.whl |
|---|---|
| Size | 19.7 MB |
| Tags | CPython 3.10 abi3 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
91168659d39748d72c2acfca70ee24319f617e2fadb4f4f2e97d18bf1762bb28
|
|
BLAKE2b-256 checksum How to use checksums |
e04ad78da9c994c1c5697b650a61d87add837831c02ef1d1bb813257b1479421
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 25, 2026.
Transparency logRelease files / pywr-2.0.0b6-cp310-abi3-macosx_10_12_x86_64.whl
| Download URL | pywr-2.0.0b6-cp310-abi3-macosx_10_12_x86_64.whl |
|---|---|
| Size | 20.7 MB |
| Tags | CPython 3.10 abi3 macOS 10.12+ x86-64 |
|
SHA-256 checksum How to use checksums |
f8b073ce5261a3a110b4fb9f7d4284661e740375630bb7288e4981a107fcd322
|
|
BLAKE2b-256 checksum How to use checksums |
d9f7d7abbfb2fde92722d8f7565ef08fc9a09f116706344b5f44c7e0f6ba1ce5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 25, 2026.
Transparency log
