PkgFoundry
Catalog PyPI
Back to packageRELEASE DETAILS

0.6.4

PyPI

agentlib-mpc

Framework for development and execution of agents for control and simulation of energy systems.

agentscontroldistributedmpc
Published17 Dec 2024
Direct dependencies19
Transitive dependenciesNot calculated

README

Version 0.6.4 documentation

agentlib_mpc

License pylint documentation

This is a plugin for AgentLib. Includes functions for modeling with CasADi, and using those models in nonlinear MPC, central and distributed (based on ADMM).

See examples and the tutorial in the docs. Best example to start is an MPC for a single air conditioned room.

Installation

Install with:

pip install agentlib_mpc

To install with full dependencies (recommended), run:

pip install agentlib_mpc[full]

Optional Dependencies

AgentLib_MPC has a number of optional dependencies:

  • fmu: Support simulation of FMU models (https://fmi-standard.org/).
  • ml: Use machine learning based NARX models for MPC. Currently supports neural networks, gaussian process regression and linear regression. Installs tensorflow, keras and scikit-learn.
  • interactive: Utility functions for displaying mpc results in an interactive dashboard. Installs plotly and dash.

Install these like

pip install agentlib_mpc[ml]

Citing AgentLib_MPC

For now, please cite the base framework under https://github.com/RWTH-EBC/AgentLib.

A preprint is available under http://dx.doi.org/10.2139/ssrn.4884846 and can be cited as:

Eser, Steffen and Storek, Thomas and Wüllhorst, Fabian and Dähling, Stefan and Gall, Jan and Stoffel, Phillip and Müller, Dirk, A Modular Python Framework for Rapid Development of Advanced Control Algorithms for Energy Systems. Available at SSRN: https://ssrn.com/abstract=4884846 or http://dx.doi.org/10.2139/ssrn.4884846

When using AgentLib-MPC, please remember to cite other tools that you are using, for example CasADi or IPOPT.

Acknowledgments

We gratefully acknowledge the financial support by Federal Ministry \ for Economic Affairs and Climate Action (BMWK), promotional reference 03ET1495A.

BMWK

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 22

Native requirements
19 direct targetsNot calculated transitive count
Package / targetRequirementRelationship
numpy
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.9",
  "evaluation": "NOT_EVALUATED"
}
numpy<2.0,>=1.17.4runtime
pandas
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.9",
  "evaluation": "NOT_EVALUATED"
}
pandas>=1.1.0runtime
scipy
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.9",
  "evaluation": "NOT_EVALUATED"
}
scipy>=1.5.2runtime
simpy
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.9",
  "evaluation": "NOT_EVALUATED"
}
simpy>=4.0.1runtime
pydantic
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.9",
  "evaluation": "NOT_EVALUATED"
}
pydantic>=2.0.0runtime
casadi
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.9",
  "evaluation": "NOT_EVALUATED"
}
casadi>=3.6.6runtime
matplotlib
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.9",
  "evaluation": "NOT_EVALUATED"
}
matplotlib>=3.5.1runtime
matplotlib
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.9",
  "evaluation": "NOT_EVALUATED"
}
matplotlibruntime
attrs
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.9",
  "evaluation": "NOT_EVALUATED"
}
attrs>=22.2.0runtime
agentlib
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.9",
  "evaluation": "NOT_EVALUATED"
}
agentlib>=0.6.0runtime
orjson
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.9",
  "evaluation": "NOT_EVALUATED"
}
orjson>=3.9.5runtime
rapidfuzz
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.9",
  "evaluation": "NOT_EVALUATED"
}
rapidfuzz>=1.7.0runtime
agentlib
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.9",
  "evaluation": "NOT_EVALUATED"
}
agentlib>=0.8.0runtime
FMPy
Environment
{
  "extras": "",
  "marker": "extra == \"fmu\"",
  "requires_python": ">=3.9",
  "evaluation": "NOT_EVALUATED"
}
FMPy>=0.3.6; extra == "fmu"runtime
keras
Environment
{
  "extras": "",
  "marker": "extra == \"ml\"",
  "requires_python": ">=3.9",
  "evaluation": "NOT_EVALUATED"
}
keras>=2.6.0; extra == "ml"runtime
tensorflow
Environment
{
  "extras": "",
  "marker": "extra == \"ml\"",
  "requires_python": ">=3.9",
  "evaluation": "NOT_EVALUATED"
}
tensorflow>=2.6.0; extra == "ml"runtime
scikit-learn
Environment
{
  "extras": "",
  "marker": "extra == \"ml\"",
  "requires_python": ">=3.9",
  "evaluation": "NOT_EVALUATED"
}
scikit-learn; extra == "ml"runtime
plotly
Environment
{
  "extras": "",
  "marker": "extra == \"interactive\"",
  "requires_python": ">=3.9",
  "evaluation": "NOT_EVALUATED"
}
plotly>=5.20.0; extra == "interactive"runtime
dash
Environment
{
  "extras": "",
  "marker": "extra == \"interactive\"",
  "requires_python": ">=3.9",
  "evaluation": "NOT_EVALUATED"
}
dash>=2.16.1; extra == "interactive"runtime
dash_daq
Environment
{
  "extras": "",
  "marker": "extra == \"interactive\"",
  "requires_python": ">=3.9",
  "evaluation": "NOT_EVALUATED"
}
dash_daq; extra == "interactive"runtime
agentlib_mpc
Environment
{
  "extras": "fmu,interactive,ml",
  "marker": "extra == \"full\"",
  "requires_python": ">=3.9",
  "evaluation": "NOT_EVALUATED"
}
agentlib_mpc[fmu,interactive,ml]; extra == "full"runtime
agentlib
Environment
{
  "extras": "full",
  "marker": "extra == \"full\"",
  "requires_python": ">=3.9",
  "evaluation": "NOT_EVALUATED"
}
agentlib[full]; extra == "full"runtime

Distribution files

2 collected
agentlib_mpc-0.6.4-py3-none-any.whl

bdist_wheel · 167.74 KB · Python py3

Source file
agentlib_mpc-0.6.4.tar.gz

sdist · 463.27 KB · Python source

Source file

Metadata history

Meaningful changes
Current collected state Current

Observed since 20 Oct, 22:34 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package_version:52f76a24a304a3bdb5525d454e53152f49acd310c90d9d1cf3cef32401abb76f

Other collected versions

View all collected versions →