Metadata-Version: 2.1
Name: esa
Version: 1.0.1
Summary: Easy SimAuto (ESA): An easy-to-use Python connector to PowerWorld Simulator Automation Server (SimAuto).
Home-page: https://github.com/mzy2240/ESA
Author: Zeyu Mao, Brandon Thayer, Yijing Liu
Author-email: zeyumao2@tamu.edu, blthayer@tamu.edu, yiji21@tamu.edu
License: MIT
Description: Easy SimAuto (ESA)
        ==================
        
        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 following citation:
        
        .. code:: latex
        
           @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 <https://mzy2240.github
        .io/ESA/html/installation.html>`__ for full, detailed installation
        directions. In many cases, ESA can simply be installed by:
        
        .. code:: bat
        
            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
        <https://pypi.org/project/coverage/>`__.
        
        .. table:: ESA's testing coverage as of 2020-04-14 (Git commit: 463a8c0)
            :widths: auto
            :align: left
        
            +-----------------+-------------------+-----------------+-----------------+--------------------+
            | 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 <https://choosealicense.com/licenses/mit/>`__
        
        Contributing
        ------------
        
        We welcome contributions! Please read ``contributing.md``.
        
        .. _documentation: https://mzy2240.github.io/ESA/
        .. _documented: https://mzy2240.github.io/ESA/
Keywords: Python,PowerWorld,PowerWorld Simulator,Simulator,PowerWorld Simulation Automation Server,SimAuto,Automation,Power Systems,Electric Power,Power,Easy SimAuto,ESA,Smart Grid,Numpy,Pandas
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: OSI Approved :: MIT 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.5
Description-Content-Type: text/x-rst
Provides-Extra: test
Provides-Extra: doc
