esapp 0.1.0__tar.gz

esapp-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2022 Zeyu Mao, Brandon Thayer, and Yijing Liu
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

esapp-0.1.0/PKG-INFO

@@ -0,0 +1,173 @@
+Metadata-Version: 2.4
+Name: esapp
+Version: 0.1.0
+Summary: ESA++ is an open-source power-grid toolkit.
+Author-email: Adam Birchfield <abirchfield@tamu.edu>, Luke Lowery <wyattluke.lowery@tamu.edu>
+License: Apache License 2.0
+Project-URL: Homepage, https://github.com/lukelowry/ESApp
+Keywords: Python,PowerWorld,PowerWorld Simulator,Simulator,PowerWorld Simulation Automation Server,SimAuto,Automation,Power Systems,Electric Power,Power,Easy SimAuto,ESA,ESAplus,Smart Grid
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Win32 (MS Windows)
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: Natural Language :: English
+Classifier: Topic :: Education
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development
+Requires-Python: >=3.7
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: pandas
+Requires-Dist: numpy<2.0
+Requires-Dist: scipy
+Requires-Dist: pywin32; sys_platform == "win32"
+Provides-Extra: test
+Requires-Dist: pytest>=7.0; extra == "test"
+Requires-Dist: pytest-cov>=4.0; extra == "test"
+Requires-Dist: pytest-xdist>=3.0; extra == "test"
+Requires-Dist: pytest-timeout>=2.1; extra == "test"
+Requires-Dist: pytest-mock>=3.10; extra == "test"
+Requires-Dist: pytest-order>=1.2; extra == "test"
+Provides-Extra: dev
+Requires-Dist: matplotlib; extra == "dev"
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Requires-Dist: pytest-order>=1.2; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx-rtd-theme; extra == "docs"
+Requires-Dist: sphinx-copybutton; extra == "docs"
+Requires-Dist: nbsphinx; extra == "docs"
+Requires-Dist: ipykernel; extra == "docs"
+Requires-Dist: matplotlib; extra == "docs"
+Dynamic: license-file
+
+ESA++
+====================================
+
+.. image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg
+   :target: https://opensource.org/licenses/Apache-2.0
+   :alt: License
+
+.. image:: https://img.shields.io/badge/python-3.9%2B-blue.svg
+   :target: https://www.python.org/downloads/
+   :alt: Python 3.9+
+
+.. image:: https://img.shields.io/badge/docs-Read%20the%20Docs-blue.svg
+   :target: https://esapp.readthedocs.io/
+   :alt: Documentation
+
+.. image:: https://img.shields.io/badge/coverage-92%25-brightgreen.svg
+   :alt: Coverage 92%
+
+An open-source Python toolkit for power system automation, providing a high-performance "syntax-sugar" fork of Easy SimAuto (ESA). This library streamlines interaction with PowerWorld's Simulator Automation Server (SimAuto), transforming complex COM calls into intuitive, Pythonic operations.
+
+Key Features
+------------
+
+- **Intuitive Indexing Syntax**: Access and modify grid components using a unique indexing system (e.g., ``wb[Bus, "BusPUVolt"]``) that feels like native Python.
+- **Comprehensive SimAuto Wrapper**: Full coverage of PowerWorld's API through the ``SAW`` class, organized into modular mixins for power flow, contingencies, transients, and more.
+- **High-Level Adapter Interface**: A collection of simplified "one-liner" functions for common tasks like GIC calculation, fault analysis, and voltage violation detection.
+- **Native Pandas Integration**: Every data retrieval operation returns a Pandas DataFrame or Series, enabling immediate analysis, filtering, and visualization.
+- **Advanced Analysis Apps**: Built-in specialized modules for Network topology analysis, Geomagnetically Induced Currents (GIC), and Forced Oscillation detection.
+
+Installation
+------------
+
+For local development and the latest features, install the package in editable mode from the root directory:
+
+.. code-block:: bash
+
+    python -m pip install esapp -e .
+
+
+Documentation
+-------------
+
+For a comprehensive tutorial, usage guides, and the full API reference, please visit our `documentation website <https://esapp.readthedocs.io/>`_.
+
+Usage Example
+-------------
+
+Here is a quick example of how ESA++ simplifies data access and power flow analysis.
+
+.. code-block:: python
+
+    from esapp import GridWorkBench
+    from esapp.grid import *
+
+    # Open Case
+    wb = GridWorkBench("path/to/case.pwb")
+
+    # Retrieve data 
+    bus_data = wb[Bus, ["BusName", "BusPUVolt"]]
+
+    # Solve power flow
+    V = wb.pflow()
+
+    # Do some action, write to PW
+    violations = wb.find_violations(v_min=0.95)
+    wb[Gen, "GenMW"] = 100.0
+
+    # Save case
+    wb.save()
+
+Why ESA++?
+----------
+
+Traditional automation of PowerWorld Simulator often involves verbose COM calls and manual data parsing. ESA++ abstracts these complexities:
+
+*   **Speed**: Optimized data transfer between Python and SimAuto.
+*   **Clarity**: Code that reads like the engineering operations it performs.
+*   **Ecosystem**: Built on top of the proven ESA library, adding modern Python features and better integration with the SciPy stack.
+
+
+More Examples
+-------------
+
+The `examples/ <https://github.com/lukelowry/ESApp/tree/main/docs/examples>`_ directory contains a gallery of demonstrations, including:
+
+- **Object Field Access**: Reduce the time you spend searching for field names with ESA++ IDE typehints for objects and fields.
+- **Matrix Extraction**: Retrieving Y-Bus, Jacobian, and GIC conductance matrices for external mathematical modeling.
+
+Testing
+-------
+
+ESA++ includes an extensive test suite covering both offline mocks and live PowerWorld connections. To run the tests, install the test dependencies and execute pytest:
+
+.. code-block:: bash
+
+    pip install .[test]
+    pytest tests/test_saw.py
+
+Citation
+--------
+
+If you use this toolkit in your research or industrial projects, please cite the original ESA work and this fork:
+
+.. code-block:: bibtex
+
+    @article{esa2020,
+      title={Easy SimAuto (ESA): A Python Package for PowerWorld Simulator Automation},
+      author={Mao, Zeyu and Thayer, Brandon and Liu, Yijing and Birchfield, Adam},
+      year={2020}
+    }
+
+Authors
+-------
+
+Luke Lowery developed this module during his PhD studies at Texas A&M University. You can learn more on his `research page <https://lukelowry.github.io/>`_ or view his publications on `Google Scholar <https://scholar.google.com/citations?user=CTynuRMAAAAJ&hl=en>`_.
+
+ESA++ is maintained by **Luke Lowery** and **Adam Birchfield** at Texas A&M University. You can explore more of our research at the `Birchfield Research Group <https://birchfield.engr.tamu.edu/>`_.
+
+License
+-------
+Distributed under the `Apache License 2.0 <https://www.apache.org/licenses/LICENSE-2.0>`_.

esapp-0.1.0/README.rst

@@ -0,0 +1,121 @@
+ESA++
+====================================
+
+.. image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg
+   :target: https://opensource.org/licenses/Apache-2.0
+   :alt: License
+
+.. image:: https://img.shields.io/badge/python-3.9%2B-blue.svg
+   :target: https://www.python.org/downloads/
+   :alt: Python 3.9+
+
+.. image:: https://img.shields.io/badge/docs-Read%20the%20Docs-blue.svg
+   :target: https://esapp.readthedocs.io/
+   :alt: Documentation
+
+.. image:: https://img.shields.io/badge/coverage-92%25-brightgreen.svg
+   :alt: Coverage 92%
+
+An open-source Python toolkit for power system automation, providing a high-performance "syntax-sugar" fork of Easy SimAuto (ESA). This library streamlines interaction with PowerWorld's Simulator Automation Server (SimAuto), transforming complex COM calls into intuitive, Pythonic operations.
+
+Key Features
+------------
+
+- **Intuitive Indexing Syntax**: Access and modify grid components using a unique indexing system (e.g., ``wb[Bus, "BusPUVolt"]``) that feels like native Python.
+- **Comprehensive SimAuto Wrapper**: Full coverage of PowerWorld's API through the ``SAW`` class, organized into modular mixins for power flow, contingencies, transients, and more.
+- **High-Level Adapter Interface**: A collection of simplified "one-liner" functions for common tasks like GIC calculation, fault analysis, and voltage violation detection.
+- **Native Pandas Integration**: Every data retrieval operation returns a Pandas DataFrame or Series, enabling immediate analysis, filtering, and visualization.
+- **Advanced Analysis Apps**: Built-in specialized modules for Network topology analysis, Geomagnetically Induced Currents (GIC), and Forced Oscillation detection.
+
+Installation
+------------
+
+For local development and the latest features, install the package in editable mode from the root directory:
+
+.. code-block:: bash
+
+    python -m pip install esapp -e .
+
+
+Documentation
+-------------
+
+For a comprehensive tutorial, usage guides, and the full API reference, please visit our `documentation website <https://esapp.readthedocs.io/>`_.
+
+Usage Example
+-------------
+
+Here is a quick example of how ESA++ simplifies data access and power flow analysis.
+
+.. code-block:: python
+
+    from esapp import GridWorkBench
+    from esapp.grid import *
+
+    # Open Case
+    wb = GridWorkBench("path/to/case.pwb")
+
+    # Retrieve data 
+    bus_data = wb[Bus, ["BusName", "BusPUVolt"]]
+
+    # Solve power flow
+    V = wb.pflow()
+
+    # Do some action, write to PW
+    violations = wb.find_violations(v_min=0.95)
+    wb[Gen, "GenMW"] = 100.0
+
+    # Save case
+    wb.save()
+
+Why ESA++?
+----------
+
+Traditional automation of PowerWorld Simulator often involves verbose COM calls and manual data parsing. ESA++ abstracts these complexities:
+
+*   **Speed**: Optimized data transfer between Python and SimAuto.
+*   **Clarity**: Code that reads like the engineering operations it performs.
+*   **Ecosystem**: Built on top of the proven ESA library, adding modern Python features and better integration with the SciPy stack.
+
+
+More Examples
+-------------
+
+The `examples/ <https://github.com/lukelowry/ESApp/tree/main/docs/examples>`_ directory contains a gallery of demonstrations, including:
+
+- **Object Field Access**: Reduce the time you spend searching for field names with ESA++ IDE typehints for objects and fields.
+- **Matrix Extraction**: Retrieving Y-Bus, Jacobian, and GIC conductance matrices for external mathematical modeling.
+
+Testing
+-------
+
+ESA++ includes an extensive test suite covering both offline mocks and live PowerWorld connections. To run the tests, install the test dependencies and execute pytest:
+
+.. code-block:: bash
+
+    pip install .[test]
+    pytest tests/test_saw.py
+
+Citation
+--------
+
+If you use this toolkit in your research or industrial projects, please cite the original ESA work and this fork:
+
+.. code-block:: bibtex
+
+    @article{esa2020,
+      title={Easy SimAuto (ESA): A Python Package for PowerWorld Simulator Automation},
+      author={Mao, Zeyu and Thayer, Brandon and Liu, Yijing and Birchfield, Adam},
+      year={2020}
+    }
+
+Authors
+-------
+
+Luke Lowery developed this module during his PhD studies at Texas A&M University. You can learn more on his `research page <https://lukelowry.github.io/>`_ or view his publications on `Google Scholar <https://scholar.google.com/citations?user=CTynuRMAAAAJ&hl=en>`_.
+
+ESA++ is maintained by **Luke Lowery** and **Adam Birchfield** at Texas A&M University. You can explore more of our research at the `Birchfield Research Group <https://birchfield.engr.tamu.edu/>`_.
+
+License
+-------
+Distributed under the `Apache License 2.0 <https://www.apache.org/licenses/LICENSE-2.0>`_.

esapp-0.1.0/VERSION

@@ -0,0 +1 @@
+0.1.0

esapp-0.1.0/docs/conf.py

@@ -0,0 +1,96 @@
+import os
+import sys
+import importlib.metadata
+
+# Ensure the project root is in the path
+sys.path.insert(0, os.path.abspath(".."))
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary", # Re-enabled to allow automatic class listing
+    "sphinx.ext.viewcode",
+    "sphinx.ext.todo",
+    "sphinx.ext.mathjax",
+    "sphinx.ext.inheritance_diagram",
+    "sphinx.ext.autosectionlabel",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.napoleon",
+    "sphinx_copybutton",
+    "nbsphinx",
+]
+
+autosummary_generate = True  
+
+autodoc_default_options = {
+    "member-order": "groupwise",
+}
+
+autodoc_preserve_defaults = True
+todo_include_todos = True
+autosectionlabel_prefix_document = True
+
+autoclass_content = "both"
+autodoc_typehints = "none"
+add_module_names = False
+
+intersphinx_mapping = {
+    "python": ("docs.python.org", None),
+    "numpy": ("numpy.org", None),
+    "scipy": ("docs.scipy.org", None),
+}
+
+napoleon_google_docstring = False
+napoleon_numpy_docstring = True
+napoleon_include_init_with_doc = False
+napoleon_use_param = True
+napoleon_use_rtype = True
+napoleon_preprocess_types = True
+napoleon_type_aliases = {
+    "np": "numpy",
+    "np.ndarray": "~numpy.ndarray",
+    "pd": "pandas",
+    "pd.DataFrame": "~pandas.DataFrame",
+    "optional": "typing.Optional",
+    "union": "typing.Union",
+}
+
+exclude_patterns = [
+    "_build",
+    "**/*.cpg",
+    "**/*.dbf",
+    "**/*.prj",
+    "**/*.shp",
+    "**/*.shx",
+    "**/Shape.xml",
+    "**/Shape.shp.ea.iso.xml",
+    "**/PWRaw",
+]
+
+nbsphinx_execute = 'never'
+html_sourcelink_suffix = ''
+master_doc = "index"
+
+project = "ESA++"
+copyright = "2026, Luke Lowery"
+author = "Luke Lowery"
+
+try:
+    version = importlib.metadata.version("esapp")
+except importlib.metadata.PackageNotFoundError:
+    version = "unknown"
+release = version
+
+html_theme = "sphinx_rtd_theme"
+html_theme_options = {
+    "navigation_depth": 2,
+}
+
+autodoc_mock_imports = [
+    "win32com", 
+    "win32com.client", 
+    "pythoncom",
+    "geopandas",
+    "shapely",
+    "fiona",
+    "pyproj",
+]

esapp-0.1.0/esapp/__init__.py

@@ -0,0 +1,26 @@
+"""
+esapp: A Pythonic Interface for PowerWorld Simulator
+=====================================================
+
+The ``esapp`` package provides a high-level, object-oriented interface for
+interacting with PowerWorld Simulator's Automation Server (SimAuto). It aims
+to simplify common power systems analysis tasks by providing a more Pythonic
+and user-friendly API.
+
+The main entry point is the :class:`~.GridWorkBench` class.
+"""
+
+# Please keep the docstring above up to date with all the imports.
+from .saw import (
+    SAW,
+    PowerWorldError,
+    COMError,
+    CommandNotRespectedError,
+    Error,
+    SimAutoFeatureError,
+    PowerWorldPrerequisiteError,
+    PowerWorldAddonError,
+)
+
+# Main Grid Work Bench Class
+from .workbench import GridWorkBench

esapp-0.1.0/esapp/apps/__init__.py

@@ -0,0 +1,19 @@
+"""
+Specialized Applications (:mod:`esapp.apps`)
+============================================
+
+This package contains higher-level, specialized tools for advanced power
+systems analysis tasks built on top of the core ``esapp`` components.
+"""
+
+# Applications
+from .gic import GIC
+from .network import Network, BranchType
+from .modes import ForcedOscillation
+
+__all__ = [
+    "GIC",
+    "Network",
+    "BranchType",
+    "ForcedOscillation",
+]