Skip to main content

pyomo-cvp

PyPI Python versions CI License

Control vector parameterization for pyomo.dae.

pyomo.dae makes control profiles piecewise-constant by adding linking equality constraints (reduce_collocation_points), which keeps every collocation-point copy of the control in the model plus one equation per tied copy. pyomo-cvp does it by elimination: after any DAE discretization, each declared control keeps only its profile's free values, every other copy is substituted out of the model, and the component is replaced under its own name. The model you solve is the model you meant: no extra variables, no linking constraints.

On the classic race car problem (nfe=15, ncp=3, Lagrange-Radau):

control vars linking constraints
reduce_collocation_points 46 30
cvp.parameterize 15 0

Install

pip install pyomo-cvp

Usage

import pyomo.environ as pyo
from pyomo_cvp import declare_profile, control_value

# ... build a pyomo.dae model with control m.u over ContinuousSet m.tau ...
declare_profile(m.u, wrt=m.tau, profile="piecewise_constant")

pyo.TransformationFactory("dae.collocation").apply_to(
    m, nfe=15, ncp=3, scheme="LAGRANGE-RADAU")
pyo.TransformationFactory("cvp.parameterize").apply_to(m)

# m.u now has exactly nfe members, one per finite element
pyo.SolverFactory("ipopt").solve(m)
control_value(m.u, 0.5)   # evaluate the profile at any time

The explicit form (no declaration) is equivalent:

pyo.TransformationFactory("cvp.parameterize").apply_to(
    m, var=m.u, contset=m.tau, profile="piecewise_constant")

Works with any pyomo.dae discretization: Lagrange-Radau, Lagrange-Legendre (where it also eliminates the dangling element-boundary copies the constraint-based approach leaves unconstrained), or finite difference. Controls may carry additional (non-time) indices.

Profiles

  • 'piecewise_constant' --- one free value per finite element, indexed by the element's start time (u[t0] exists; the final time carries no control).
  • 'piecewise_linear' --- one free value per element boundary, continuous, interior points interpolated.
  • ('reduced_collocation', k) --- k free values per element (the last k collocation points), Lagrange interpolation elsewhere; the elimination form of reduce_collocation_points(ncp=k).

Examples

Worked notebooks under examples/:

Install their dependencies with pip install pyomo-cvp[examples].

Citing

If you use this package, please also cite the pyomo.dae framework it builds on:

Nicholson, B., Siirola, J.D., Watson, J.-P., Zavala, V.M., Biegler, L.T. (2018). pyomo.dae: a modeling and automatic discretization framework for optimization with differential and algebraic equations. Mathematical Programming Computation 10(2), 187-223. doi:10.1007/s12532-017-0127-0

@article{nicholson2018pyomodae,
  author  = {Nicholson, Bethany and Siirola, John D. and Watson, Jean-Paul
             and Zavala, Victor M. and Biegler, Lorenz T.},
  title   = {pyomo.dae: a modeling and automatic discretization framework
             for optimization with differential and algebraic equations},
  journal = {Mathematical Programming Computation},
  volume  = {10},
  number  = {2},
  pages   = {187--223},
  year    = {2018},
  doi     = {10.1007/s12532-017-0127-0}
}

Maintainer

Maintained by @devin-griff. Issues and pull requests welcome.

License

BSD 3-Clause License. See LICENSE.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyomo_cvp-0.5.0.tar.gz (151.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyomo_cvp-0.5.0-py3-none-any.whl (12.0 kB view details)

Uploaded Python 3

File details

Details for the file pyomo_cvp-0.5.0.tar.gz.

File metadata

  • Download URL: pyomo_cvp-0.5.0.tar.gz
  • Upload date:
  • Size: 151.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pyomo_cvp-0.5.0.tar.gz
Algorithm Hash digest
SHA256 01a5b72c313ec03f62b1d8419adbfc5d37d1da27b8338ba267ada4028389d43a
MD5 ff7350690d93db4d5610d070ddae90a8
BLAKE2b-256 d800d2da85e575387fddb5883657d8b8aaff0eff04b465b61887dae67d32a5c0

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyomo_cvp-0.5.0.tar.gz:

Publisher: publish.yml on devin-griff/pyomo-cvp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyomo_cvp-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: pyomo_cvp-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 12.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pyomo_cvp-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0daa197af334d9ab2b0d4d224ccade7c9170fc9e49fc8da4355216668215f212
MD5 0cec9c2b4b6d0bda1e6553ef77f26581
BLAKE2b-256 832cbed8a1dbc98608e5db3f0629a10f0014813eaf3b6e9660ce56c7baa79162

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyomo_cvp-0.5.0-py3-none-any.whl:

Publisher: publish.yml on devin-griff/pyomo-cvp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.7.2

2 files

0.7.1

2 files

0.7.0

2 files

0.6.3.1

2 files

0.6.3

2 files

0.6.2

2 files

0.6.1

2 files

0.6.0

2 files

This release

0.5.0 This release

2 files

0.4.0

2 files

0.3.0

2 files

0.2.0

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page