# LTB ANDES
<img src="docs/source/images/sponsors/CURENT_Logo_NameOnTrans.png" alt="CURENT ERC Logo" width="300" height="auto">
Python software for symbolic power system modeling and numerical analysis, serving as the core simulation engine for the [CURENT Largescale Testbed][LTB Repositories].
| | Latest | Stable |
|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
| Documentation | [](https://andes.readthedocs.io/en/latest/?badge=latest) | [](https://andes.readthedocs.io/en/stable/?badge=stable) |
| Badges | | |
|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Downloads | [](https://pypi.python.org/pypi/andes) | [](https://anaconda.org/conda-forge/andes) |
| Try on Binder | [](https://mybinder.org/v2/gh/curent/andes/master) | |
| Code Quality | [](https://app.codacy.com/app/curent/andes?utm_source=github.com&utm_medium=referral&utm_content=curent/andes&utm_campaign=Badge_Grade_Dashboard) | [](https://codecov.io/gh/curent/andes) |
| Build Status | [](https://github.com/curent/andes/actions) | [](https://dev.azure.com/hcui7/hcui7/_build/latest?definitionId=1&branchName=master) |
# Why ANDES
This software could be of interest to you if you are working on
DAE modeling, simulation, and control for power systems.
It has features that may be useful if you are applying
deep (reinforcement) learning to such systems.
ANDES is by far easier to use for developing differential-algebraic
equation (DAE) based models for power system dynamic simulation
than other tools such as
[PSAT](http://faraday1.ucd.ie/psat.html),
[Dome](http://faraday1.ucd.ie/dome.html) and
[PST](https://www.ecse.rpi.edu/~chowj/),
while maintaining high numerical efficiency.
ANDES comes with a rich set of commercial-grade dynamic models
with all details implemented, including limiters, saturation,
and zeroing out time constants.
ANDES produces credible simulation results. The following table
shows that
1. For the Northeast Power Coordinating Council (NPCC) 140-bus system
(with GENROU, GENCLS, TGOV1 and IEEEX1),
ANDES results match perfectly with that from TSAT.
2. For the Western Electricity Coordinating Council (WECC) 179-bus
system (with GENROU, IEEEG1, EXST1, ESST3A, ESDC2A, IEEEST and
ST2CUT), ANDES results match closely with those from TSAT and PSS/E.
Note that TSAT and PSS/E results are not identical, either.
| NPCC Case Study | WECC Case Study |
| --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|  |  |
ANDES provides a descriptive modeling framework in a scripting environment.
Modeling DAE-based devices is as simple as describing the mathematical equations.
Numerical code will be automatically generated for fast simulation.
| Controller Model and Equation | ANDES Code |
| ----------------------------- | ---------- |
| Diagram: <br>  <br> Write into DAEs: <br>  |  |
In ANDES, what you simulate is what you document.
ANDES automatically generates model documentation, and the docs always stay up to date.
The screenshot below is the generated documentation for the implemented IEEEG1 model.
In addition, ANDES features
* a rich library of transfer functions and discontinuous components (including limiters, deadbands, and
saturation functions) available for model prototyping and system analysis.
* industry-grade second-generation renewable models (solar PV, type 3 and type 4 wind),
distributed PV and energy storage model.
* routines including Newton method for power flow calculation, implicit trapezoidal method for time-domain
simulation, and full eigenvalue analysis.
* developed with performance in mind. While written in Python, ANDES can
finish a 20-second transient simulation of a 2000-bus system in a few seconds on a typical desktop computer.
* out-of-the-box PSS/E raw and dyr data support for available models. Once a model is developed, inputs from a
dyr file can be immediately supported.
ANDES is currently under active development.
Use the following resources to get involved.
+ Start from the [documentation][readthedocs] for installation and tutorial.
+ Check out examples in the [examples folder][examples]
+ Read the model verification results in the [examples/verification folder][verification]
+ Try in Jupyter Notebook on [Binder][Binder]
+ Ask a question in the [GitHub Discussions][Github Discussions]
+ Report bugs or issues by submitting a [GitHub issue][GitHub issues]
+ Submit contributions using [pull requests][GitHub pull requests]
+ Read release notes highlighted [here][release notes]
+ Check out and and cite our [paper][arxiv paper]
# Citing ANDES
If you use ANDES for research or consulting, please cite the following paper in your publication that uses
ANDES
```
H. Cui, F. Li and K. Tomsovic, "Hybrid Symbolic-Numeric Framework for Power System Modeling and Analysis," in IEEE Transactions on Power Systems, vol. 36, no. 2, pp. 1373-1384, March 2021, doi: 10.1109/TPWRS.2020.3017019.
```
# Who is Using ANDES?
Please let us know if you are using ANDES for research or projects.
We kindly request you to cite our [paper][arxiv paper] if you find ANDES useful.
# Sponsors and Contributors
This work was supported in part by the Engineering Research Center
Program of the National Science Foundation and the Department of Energy
under NSF Award Number EEC-1041877 and the CURENT Industry Partnership
Program.
This work was supported in part by the Advanced Grid Research and Development Program
in the Office of Electricity at the U.S. Department of Energy.
See [GitHub contributors][GitHub contributors] for the contributor list.
# License
ANDES is licensed under the [GPL v3 License](./LICENSE).
* * *
[GitHub releases]: https://github.com/CURENT/andes/releases
[GitHub issues]: https://github.com/CURENT/andes/issues
[Github Discussions]: https://github.com/CURENT/andes/discussions
[GitHub insights]: https://github.com/CURENT/andes/pulse
[GitHub pull requests]: https://github.com/CURENT/andes/pulls
[GitHub contributors]: https://github.com/CURENT/andes/graphs/contributors
[readthedocs]: https://andes.readthedocs.io
[release notes]: https://andes.readthedocs.io/en/latest/release-notes.html
[arxiv paper]: https://arxiv.org/abs/2002.09455
[tutorial]: https://andes.readthedocs.io/en/latest/tutorial.html#interactive-usage
[examples]: https://github.com/CURENT/andes/tree/master/examples
[verification]: https://github.com/CURENT/andes/tree/master/examples/verification
[Binder]: https://mybinder.org/v2/gh/curent/andes/master
[LTB Repositories]: https://github.com/CURENT
Raw data
{
"_id": null,
"home_page": "https://github.com/curent/andes",
"name": "andes",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Hantao Cui",
"author_email": "cuihantao@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/d5/35/a0f5d18222526e743bde599f20339792877fabf36c389dbb6f13139783ee/andes-1.9.2.tar.gz",
"platform": null,
"description": "# LTB ANDES\n\n<img src=\"docs/source/images/sponsors/CURENT_Logo_NameOnTrans.png\" alt=\"CURENT ERC Logo\" width=\"300\" height=\"auto\">\n\nPython software for symbolic power system modeling and numerical analysis, serving as the core simulation engine for the [CURENT Largescale Testbed][LTB Repositories].\n\n| | Latest | Stable |\n|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|\n| Documentation | [](https://andes.readthedocs.io/en/latest/?badge=latest) | [](https://andes.readthedocs.io/en/stable/?badge=stable) |\n\n| Badges | | |\n|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Downloads | [](https://pypi.python.org/pypi/andes) | [](https://anaconda.org/conda-forge/andes) |\n| Try on Binder | [](https://mybinder.org/v2/gh/curent/andes/master) | |\n| Code Quality | [](https://app.codacy.com/app/curent/andes?utm_source=github.com&utm_medium=referral&utm_content=curent/andes&utm_campaign=Badge_Grade_Dashboard) | [](https://codecov.io/gh/curent/andes) |\n| Build Status | [](https://github.com/curent/andes/actions) | [](https://dev.azure.com/hcui7/hcui7/_build/latest?definitionId=1&branchName=master) |\n\n# Why ANDES\nThis software could be of interest to you if you are working on\nDAE modeling, simulation, and control for power systems.\nIt has features that may be useful if you are applying\ndeep (reinforcement) learning to such systems.\n\nANDES is by far easier to use for developing differential-algebraic\nequation (DAE) based models for power system dynamic simulation\nthan other tools such as\n[PSAT](http://faraday1.ucd.ie/psat.html),\n[Dome](http://faraday1.ucd.ie/dome.html) and\n[PST](https://www.ecse.rpi.edu/~chowj/),\nwhile maintaining high numerical efficiency.\n\nANDES comes with a rich set of commercial-grade dynamic models\nwith all details implemented, including limiters, saturation,\nand zeroing out time constants.\n\nANDES produces credible simulation results. The following table\nshows that\n\n1. For the Northeast Power Coordinating Council (NPCC) 140-bus system\n(with GENROU, GENCLS, TGOV1 and IEEEX1),\nANDES results match perfectly with that from TSAT.\n\n2. For the Western Electricity Coordinating Council (WECC) 179-bus\nsystem (with GENROU, IEEEG1, EXST1, ESST3A, ESDC2A, IEEEST and\nST2CUT), ANDES results match closely with those from TSAT and PSS/E.\nNote that TSAT and PSS/E results are not identical, either.\n\n| NPCC Case Study | WECC Case Study |\n| --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |\n|  |  |\n\nANDES provides a descriptive modeling framework in a scripting environment.\nModeling DAE-based devices is as simple as describing the mathematical equations.\nNumerical code will be automatically generated for fast simulation.\n\n| Controller Model and Equation | ANDES Code |\n| ----------------------------- | ---------- |\n| Diagram: <br>  <br> Write into DAEs: <br>  |  |\n\nIn ANDES, what you simulate is what you document.\nANDES automatically generates model documentation, and the docs always stay up to date.\nThe screenshot below is the generated documentation for the implemented IEEEG1 model.\n\n\n\nIn addition, ANDES features\n\n* a rich library of transfer functions and discontinuous components (including limiters, deadbands, and\n saturation functions) available for model prototyping and system analysis.\n* industry-grade second-generation renewable models (solar PV, type 3 and type 4 wind),\n distributed PV and energy storage model.\n* routines including Newton method for power flow calculation, implicit trapezoidal method for time-domain\n simulation, and full eigenvalue analysis.\n* developed with performance in mind. While written in Python, ANDES can\n finish a 20-second transient simulation of a 2000-bus system in a few seconds on a typical desktop computer.\n* out-of-the-box PSS/E raw and dyr data support for available models. Once a model is developed, inputs from a\n dyr file can be immediately supported.\n\nANDES is currently under active development.\nUse the following resources to get involved.\n\n+ Start from the [documentation][readthedocs] for installation and tutorial.\n+ Check out examples in the [examples folder][examples]\n+ Read the model verification results in the [examples/verification folder][verification]\n+ Try in Jupyter Notebook on [Binder][Binder]\n+ Ask a question in the [GitHub Discussions][Github Discussions]\n+ Report bugs or issues by submitting a [GitHub issue][GitHub issues]\n+ Submit contributions using [pull requests][GitHub pull requests]\n+ Read release notes highlighted [here][release notes]\n+ Check out and and cite our [paper][arxiv paper]\n\n# Citing ANDES\n\nIf you use ANDES for research or consulting, please cite the following paper in your publication that uses\nANDES\n\n```\nH. Cui, F. Li and K. Tomsovic, \"Hybrid Symbolic-Numeric Framework for Power System Modeling and Analysis,\" in IEEE Transactions on Power Systems, vol. 36, no. 2, pp. 1373-1384, March 2021, doi: 10.1109/TPWRS.2020.3017019.\n```\n\n# Who is Using ANDES?\nPlease let us know if you are using ANDES for research or projects.\nWe kindly request you to cite our [paper][arxiv paper] if you find ANDES useful.\n\n\n\n\n\n\n\n# Sponsors and Contributors\nThis work was supported in part by the Engineering Research Center\nProgram of the National Science Foundation and the Department of Energy\nunder NSF Award Number EEC-1041877 and the CURENT Industry Partnership\nProgram.\n\nThis work was supported in part by the Advanced Grid Research and Development Program\nin the Office of Electricity at the U.S. Department of Energy.\n\nSee [GitHub contributors][GitHub contributors] for the contributor list.\n\n# License\n\nANDES is licensed under the [GPL v3 License](./LICENSE).\n\n* * *\n\n[GitHub releases]: https://github.com/CURENT/andes/releases\n[GitHub issues]: https://github.com/CURENT/andes/issues\n[Github Discussions]: https://github.com/CURENT/andes/discussions\n[GitHub insights]: https://github.com/CURENT/andes/pulse\n[GitHub pull requests]: https://github.com/CURENT/andes/pulls\n[GitHub contributors]: https://github.com/CURENT/andes/graphs/contributors\n[readthedocs]: https://andes.readthedocs.io\n[release notes]: https://andes.readthedocs.io/en/latest/release-notes.html\n[arxiv paper]: https://arxiv.org/abs/2002.09455\n[tutorial]: https://andes.readthedocs.io/en/latest/tutorial.html#interactive-usage\n[examples]: https://github.com/CURENT/andes/tree/master/examples\n[verification]: https://github.com/CURENT/andes/tree/master/examples/verification\n[Binder]: https://mybinder.org/v2/gh/curent/andes/master\n[LTB Repositories]: https://github.com/CURENT\n",
"bugtrack_url": null,
"license": "GNU Public License v3",
"summary": "Python software for symbolic power system modeling and numerical analysis.",
"version": "1.9.2",
"project_urls": {
"Homepage": "https://github.com/curent/andes"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d535a0f5d18222526e743bde599f20339792877fabf36c389dbb6f13139783ee",
"md5": "e83ef52276730ce986d80e4906dc7c50",
"sha256": "0c43e83420abf6b14c71995e4671273daeb484b21122579ed17d4221713f67f8"
},
"downloads": -1,
"filename": "andes-1.9.2.tar.gz",
"has_sig": false,
"md5_digest": "e83ef52276730ce986d80e4906dc7c50",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 8706647,
"upload_time": "2024-03-25T17:45:07",
"upload_time_iso_8601": "2024-03-25T17:45:07.053455Z",
"url": "https://files.pythonhosted.org/packages/d5/35/a0f5d18222526e743bde599f20339792877fabf36c389dbb6f13139783ee/andes-1.9.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-25 17:45:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "curent",
"github_project": "andes",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "kvxopt",
"specs": [
[
">=",
"1.3.2.0"
]
]
},
{
"name": "numpy",
"specs": []
},
{
"name": "scipy",
"specs": []
},
{
"name": "sympy",
"specs": [
[
"!=",
"1.10.0"
],
[
">=",
"1.6"
]
]
},
{
"name": "pandas",
"specs": []
},
{
"name": "matplotlib",
"specs": []
},
{
"name": "openpyxl",
"specs": []
},
{
"name": "xlsxwriter",
"specs": []
},
{
"name": "dill",
"specs": []
},
{
"name": "pathos",
"specs": []
},
{
"name": "tqdm",
"specs": []
},
{
"name": "pyyaml",
"specs": []
},
{
"name": "coloredlogs",
"specs": []
},
{
"name": "chardet",
"specs": []
},
{
"name": "psutil",
"specs": []
},
{
"name": "texttable",
"specs": []
},
{
"name": "numba",
"specs": []
}
],
"lcname": "andes"
}
JSON
