Metadata-Version: 2.5
Name: esapp
Version: 1.0.0rc1
Summary: Python for PowerWorld
Project-URL: Homepage, https://github.com/BirchfieldResearchGroup/esapp
Project-URL: Documentation, https://esapp.readthedocs.io
Project-URL: Issues, https://github.com/BirchfieldResearchGroup/esapp/issues
Project-URL: Changelog, https://github.com/BirchfieldResearchGroup/esapp/blob/main/CHANGELOG.md
Author-email: Luke Lowery <wyattluke.lowery@tamu.edu>, Adam Birchfield <abirchfield@tamu.edu>
License-Expression: Apache-2.0
License-File: LICENSE
Keywords: PowerWorld,SimAuto,power systems,transient stability
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering
Classifier: Typing :: Typed
Requires-Python: >=3.12
Requires-Dist: numpy>=2
Requires-Dist: pandas>=2.2
Requires-Dist: pywin32>=308; sys_platform == 'win32'
Provides-Extra: sparse
Requires-Dist: scipy>=1.14; extra == 'sparse'
Provides-Extra: testing
Requires-Dist: pytest>=9; extra == 'testing'
Description-Content-Type: text/markdown

<h1>
  <picture>
    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/BirchfieldResearchGroup/esapp/main/docs/_static/banner-dark.svg">
    <img src="https://raw.githubusercontent.com/BirchfieldResearchGroup/esapp/main/docs/_static/banner.svg" width="100%" alt="esa++: Python for PowerWorld">
  </picture>
</h1>

[![CI](https://img.shields.io/github/actions/workflow/status/BirchfieldResearchGroup/esapp/ci.yml?branch=main&label=CI)](https://github.com/BirchfieldResearchGroup/esapp/actions/workflows/ci.yml)
[![PyPI](https://img.shields.io/pypi/v/esapp?label=PyPI)](https://pypi.org/project/esapp/)
[![Python 3.12 to 3.14](https://img.shields.io/badge/python-3.12%20%7C%203.13%20%7C%203.14-blue)](https://pypi.org/project/esapp/)
[![Documentation](https://img.shields.io/readthedocs/esapp?label=docs)](https://esapp.readthedocs.io)
[![Apache 2.0 license](https://img.shields.io/badge/license-Apache%202.0-blue)](https://github.com/BirchfieldResearchGroup/esapp/blob/main/LICENSE)

esa++ is Python for PowerWorld. Read and write Simulator data as pandas DataFrames, run any script
command, and get transient stability results as NumPy arrays. Every object type and field is typed.

[Documentation](https://esapp.readthedocs.io): guide, examples, catalog and API.

```bash
pip install esapp
```

Needs Windows and PowerWorld Simulator with SimAuto.

```python
from esapp import PowerWorld
from esapp.grid import Bus, Gen

with PowerWorld("Hawaii40.pwb") as pw:
    pw.pf.solve()
    low = pw[Bus, Bus.BusName, Bus.BusPUVolt < 0.97]  # filtered inside Simulator
    pw[Gen, Gen.GenMW, Gen.AreaNum.eq(1)] = 50.0  # sets only the matching generators
```

| Module | Contents |
| --- | --- |
| `esapp` | `PowerWorld`, the session: reading, writing, selecting, commands and analyses |
| `esapp.grid` | Simulator's object types and their fields |
| `esapp.commands` | every script command, as a typed class |
| `esapp.ctg` | contingencies |
| `esapp.matrix` | the Ybus, Jacobian and G-matrix as labelled sparse arrays (`esapp[sparse]`) |
| `esapp.ts` | transient stability: contingencies, play-ins and results |
| `esapp.testing` | pytest fixtures and a fake SimAuto, to test without PowerWorld (`esapp[testing]`) |

## Author

[Luke Lowery](https://lukelowry.github.io/), PhD student in the
[Birchfield Research Group](https://birchfield.engr.tamu.edu/) at Texas A&M University ·
[Google Scholar](https://scholar.google.com/citations?user=CTynuRMAAAAJ&hl=en) ·
[ORCID](https://orcid.org/0009-0000-0029-3403)

Also by the author: [pyvectorfit](https://pyvectorfit.readthedocs.io), vector fitting for EMT line
models · [OpenLine](https://openline.readthedocs.io), overhead transmission lines ·
[latkit](https://latkit.readthedocs.io), GPU visualization of large networks.
