Metadata-Version: 2.5
Name: powfacpy
Version: 0.5.1
Summary: PowerFactory wrapper
Project-URL: Homepage, https://github.com/FraunhIEE-UniKassel-PowSysStability/powfacpy
Project-URL: Bug Tracker, https://github.com/FraunhIEE-UniKassel-PowSysStability/powfacpy/issues
Author-email: Sciemon <simon.eberlein@gmx.de>
License: Copyright (c) 2022 Fraunhofer IEE
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.11
Requires-Dist: aenum>=3.0
Requires-Dist: matplotlib>=3.5
Requires-Dist: pandas>=2.0
Provides-Extra: all
Requires-Dist: comtraderecord>=1.0.2; extra == 'all'
Requires-Dist: deepdiff>=8.6.2; extra == 'all'
Requires-Dist: jinja2>=3.0; extra == 'all'
Requires-Dist: jupyter>=1.1.1; extra == 'all'
Requires-Dist: markdown>=3.0; extra == 'all'
Requires-Dist: pandapower>=3.2; extra == 'all'
Requires-Dist: parstudy>=0.2.0; extra == 'all'
Requires-Dist: pyqt6>=6.1.0; extra == 'all'
Requires-Dist: pytest-cov>=5.0; extra == 'all'
Requires-Dist: pytest>=8.0; extra == 'all'
Requires-Dist: ruff>=0.6; extra == 'all'
Requires-Dist: scipy>=1.10; extra == 'all'
Provides-Extra: comtrade
Requires-Dist: comtraderecord>=1.0.2; extra == 'comtrade'
Provides-Extra: dev
Requires-Dist: pytest-cov>=5.0; extra == 'dev'
Requires-Dist: pytest>=8.0; extra == 'dev'
Requires-Dist: ruff>=0.6; extra == 'dev'
Provides-Extra: docs
Requires-Dist: markdown>=3.0; extra == 'docs'
Provides-Extra: dynamic-modal-analysis
Requires-Dist: jinja2>=3.0; extra == 'dynamic-modal-analysis'
Requires-Dist: scipy>=1.10; extra == 'dynamic-modal-analysis'
Provides-Extra: pandapower
Requires-Dist: pandapower>=3.2; extra == 'pandapower'
Provides-Extra: parstudy
Requires-Dist: parstudy>=0.2.0; extra == 'parstudy'
Provides-Extra: tutorials
Requires-Dist: deepdiff>=8.6.2; extra == 'tutorials'
Requires-Dist: jupyter>=1.1.1; extra == 'tutorials'
Requires-Dist: pyqt6>=6.1.0; extra == 'tutorials'
Description-Content-Type: text/markdown

# powfacpy

[![PyPI](https://img.shields.io/pypi/v/powfacpy)](https://pypi.org/project/powfacpy/)
[![Python versions](https://img.shields.io/pypi/pyversions/powfacpy)](https://pypi.org/project/powfacpy/)
[![License](https://img.shields.io/pypi/l/powfacpy)](LICENSE)

This package is a wrapper around the Python API of PowerFactory (power system simulation software by DIgSILENT) with improved syntax and functionality compared to the native API. Please have a look at the [documentation](https://fraunhiee-unikassel-powsysstability.github.io/powfacpy/docs/) for further information.

*PowerFactory* and *DIgSILENT* are trademarks of DIgSILENT GmbH. *powfacpy* is an independent, community-maintained open source project and is not affiliated with, endorsed by, or sponsored by DIgSILENT GmbH. Using *powfacpy* requires your own valid PowerFactory license and installation.


## Installation
```
pip install powfacpy
```
Some features rely on optional dependencies (e.g. `pip install powfacpy[dynamic_modal_analysis]`) - see the [installation section](https://fraunhiee-unikassel-powsysstability.github.io/powfacpy/docs/index.html#installation) of the docs for the full list of extras, or `pip install powfacpy[all]` for everything.

Requires Python >= 3.11 and your own PowerFactory installation and license.


## Why use *powfacpy*?
There are a number of reasons why you should consider using *powfacpy*:
- Increase productivity 
- Write more readable code
- Avoid running into similar problems, errors and obscurities as other users of the python interface of *PowerFactory* before you
- Having a standard way of doing things in your organization (e.g. a standard format for simulation result export) 
- Steep learning curve for *PowerFactory* beginners (helpful tutorials)


## Contact
This package is under active development and mainly maintained by *Fraunhofer IEE*. You are welcome to contribute, open issues or get in touch (simon.eberlein@iee.fraunhofer.de). 
