Easy SimAuto

An easy-to-use Power System Analysis Automation Platform atop PowerWorld's Simulator Automation Server.
https://github.com/mzy2240/ESA

Category: Energy Systems
Sub Category: Grid Analysis and Planning

Keywords

automation contingency-analysis esa graph-analysis hpc numba numpy pandas power-flow powersystem powerworld powerworld-simulator python pythran simauto simulator simulator-automation-server smart-grid transient-stability

Last synced: about 12 hours ago
JSON representation

Repository metadata

Easy SimAuto (ESA): An easy-to-use Power System Analysis Automation Environment atop PowerWorld Simulator Automation Server (SimAuto)

• Host: GitHub
• URL: https://github.com/mzy2240/ESA
• Owner: mzy2240
• License: apache-2.0
• Created: 2019-10-08T21:37:23.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2025-01-16T22:58:54.000Z (3 months ago)
• Last Synced: 2025-04-22T08:03:09.301Z (5 days ago)
• Topics: automation, contingency-analysis, esa, graph-analysis, hpc, numba, numpy, pandas, power-flow, powersystem, powerworld, powerworld-simulator, python, pythran, simauto, simulator, simulator-automation-server, smart-grid, transient-stability
• Language: Python
• Homepage: https://mzy2240.github.io/ESA/
• Size: 1.79 MB
• Stars: 47
• Watchers: 4
• Forks: 13
• Open Issues: 15
• Releases: 15
• Metadata Files:
  • Readme: README.rst
  • Contributing: contributing.md
  • License: LICENSE
  • Citation: CITATION.cff

README.rst

          Easy SimAuto (ESA)
==================
.. image:: https://img.shields.io/pypi/v/esa.svg
   :target: https://pypi.org/project/esa/
.. image:: https://img.shields.io/pypi/pyversions/esa.svg
   :target: https://pypi.org/project/esa/
.. image:: https://img.shields.io/discord/1114563747651006524
   :target: https://discord.gg/V9v8NRCT
.. image:: https://joss.theoj.org/papers/10.21105/joss.02289/status.svg
   :target: https://doi.org/10.21105/joss.02289
.. image:: https://img.shields.io/pypi/l/esa.svg
   :target: https://github.com/mzy2240/ESA/blob/master/LICENSE
.. image:: https://pepy.tech/badge/esa/month
   :target: https://pepy.tech/project/esa
.. image:: https://img.shields.io/badge/coverage-100%25-brightgreen
   :target: https://pypi.org/project/esa/


Easy SimAuto (ESA) is an easy-to-use Power System Analysis Automation
Platform atop PowerWorld's Simulator Automation Server (SimAuto).
ESA wraps all PowerWorld SimAuto functions, supports Auxiliary scripts,
provides helper functions to further simplify working with SimAuto and
also turbocharges with native implementation of SOTA algorithms. 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.

If you want to use ESA or SimAuto from julia, definitely check `EasySimauto.jl `__
for a julia wrapper of ESA.

Citation
--------

If you use ESA in any of your work, please use the citation below.

.. code:: latex

    @article{ESA,
      doi = {10.21105/joss.02289},
      url = {https://doi.org/10.21105/joss.02289},
      year = {2020},
      publisher = {The Open Journal},
      volume = {5},
      number = {50},
      pages = {2289},
      author = {Brandon L. Thayer and Zeyu Mao and Yijing Liu and Katherine Davis and Thomas J. Overbye},
      title = {Easy SimAuto (ESA): A Python Package that Simplifies Interacting with PowerWorld Simulator},
      journal = {Journal of Open Source Software}
    }

Installation
------------

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

.. code:: bat

    python -m pip install esa
    
Simulator Compatibility
-----------------------

Currently ESA supports PW Simulator V17, V18, V19, V20, V21, V22 and V23.


Testing Coverage
----------------

The ESA team works hard to ensure ESA is well tested, and we strive for
100% testing coverage (sometimes we cannot due to lack of specific add-ons). The table below shows the most up-to-date
testing coverage data for ESA, using `coverage
`__.

.. table:: ESA's testing coverage as of 2023-05-31 (Git commit: 7180cc9)
    :widths: auto
    :align: left

    +-----------------+-------------------+-----------------+-----------------+--------------------+
    | Name            |   Num. Statements |   Missing Lines |   Covered Lines |   Percent Coverage |
    +=================+===================+=================+=================+====================+
    | esa/__init__.py |                 2 |               0 |               2 |           100      |
    +-----------------+-------------------+-----------------+-----------------+--------------------+
    | esa/saw.py      |              1206 |               2 |            1204 |            99.8342 |
    +-----------------+-------------------+-----------------+-----------------+--------------------+

License
-------

`Apache License 2.0 `__

Contributing
------------

We welcome contributions! Please read ``contributing.md``.

.. _documentation: https://mzy2240.github.io/ESA/
.. _documented: https://mzy2240.github.io/ESA/

        

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Mao"
  given-names: "Zeyu"
- family-names: "Thayer"
  given-names: "Brandon"
- family-names: "Liu"
  given-names: "Yijing"
title: "Easy SimAuto (ESA)"
version: 1.2.6
doi: 10.21105/joss.02289
date-released: 2022-02-20
url: "https://github.com/mzy2240/ESA"
preferred-citation:
  type: article
  authors:
    - family-names: "Mao"
      given-names: "Zeyu"
    - family-names: "Thayer"
      given-names: "Brandon"
    - family-names: "Liu"
      given-names: "Yijing"
    - family-names: "Davis"
      given-names: "Katherine"
    - family-names: "Overbye"
      given-names: "Thomas"
  doi: "10.21105/joss.02289"
  url: "https://doi.org/10.21105/joss.02289"
  journal: "The Journal of Open Source Software"
  title: "Easy SimAuto (ESA): A Python Package that Simplifies Interacting with PowerWorld Simulator"
  volume: 5
  number: 50
  pages: 2289
  year: 2020

---

Owner metadata

• Name: Zeyu Mao
• Login: mzy2240
• Email:
• Kind: user
• Description: Open-source enthusiast, power engineer, full-stack developer, and energy-sector researcher.
• Website: https://zeyumao.com
• Location: Houston, TX
• Twitter:
• Company: DRW
• Icon url: https://avatars.githubusercontent.com/u/18620336?u=51c6201a59ac7f27fffe77f8582688eb976a5e7c&v=4
• Repositories: 8
• Last ynced at: 2023-03-03T10:30:44.435Z
• Profile URL: https://github.com/mzy2240

---

GitHub Events

Total

• Watch event: 5
• Issue comment event: 1
• Push event: 1
• Pull request event: 2
• Fork event: 1

Last Year

• Watch event: 5
• Issue comment event: 1
• Push event: 1
• Pull request event: 2
• Fork event: 1

---

Committers metadata

Last synced: 7 days ago

Name	Email	Commits
mzy2240	m****y@g****m	279
Brandon Thayer	b****r@t****u	234
SmartJingJing123	y****6@g****m	58
Zeyu Mao	z****o@d****m	11
faoh	3****h	6
SanjanaKunkolienkar	9****r	5
Daniel S. Katz	d****z@i****g	3
Collin Heist	c****t@g****m	1
ThomasC_TT	t****n@t****u	1
yiji21	y****1@t****u	1
Wei Gao	w****o@d****u	1
CIR Overbye Group	c****p@E****u	1

Committer domains:

• tamu.edu: 3
• ecelbr11519.engr.tamu.edu: 1
• du.edu: 1
• ieee.org: 1
• drwholdings.com: 1

---

Issue and Pull Request metadata

Last synced: about 12 hours ago

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/mzy2240/ESA

---

---

---

Package metadata

• Total packages: 1
• Total downloads:
  • pypi: 2,519 last-month
• Total dependent packages: 1
• Total dependent repositories: 1
• Total versions: 51
• Total maintainers: 1

---

Dependencies

Score: 14.444848551357957