esa 1.0.2

Easy SimAuto (ESA): An easy-to-use Python connector to PowerWorld Simulator Automation Server (SimAuto).

Easy SimAuto (ESA) is an easy-to-use Python package that simplifies interfacing with PowerWorld’s Simulator Automation Server (SimAuto). ESA wraps all PowerWorld SimAuto functions, and also provides helper functions to further simplify working with SimAuto. Wherever possible, data is returned as Pandas DataFrames, making analysis a breeze. ESA is well tested and fully documented.

Documentation

For quick-start directions, installation instructions, API reference, examples, and more, please check out ESA’s documentation.

If you have your own copy of the ESA repository, you can also view the documentation locally by navigating to the directory docs/html and opening index.html with your web browser.

Citation

If you use ESA in any of your work, please use the citation below. Please note that the ESA team is in the midst of working on an academic journal submission for ESA, so please check back for an up-to-date citation.

@misc{ESA,
  author = {Brandon Thayer and Zeyu Mao and Yijing Liu},
  title = {Easy SimAuto (ESA)},
  year = {2020},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/mzy2240/ESA}},
  commit = {<copy + paste the specific commit you used here>}
}

Installation

Please refer to ESA’s documentation for full, detailed installation directions. In many cases, ESA can simply be installed by:

python -m pip install esa

Testing Coverage

The ESA team works hard to ensure ESA is well tested, and we strive for 100% testing coverage. The table below shows the most up-to-date testing coverage data for ESA, using coverage.

ESA’s testing coverage as of 2020-05-11 (Git commit: 9715a0a)

Name	Num. Statements	Missing Lines	Covered Lines	Percent Coverage
esa/__init__.py	2	0	2	100
esa/saw.py	332	0	332	100

License

MIT

Contributing

We welcome contributions! Please read contributing.md.