Metadata-Version: 2.1
Name: opender
Version: 1.0.0
Summary: Open-source Distributed Energy Resources (DER) Model that represents IEEE Standard 1547-2018 requirements for steady-state and dynamic analyses
Home-page: https://github.com/epri-dev/opender
Author: Jithendar Anandan, Yiwei Ma, Wei Ren, and Paulo Radatz
Author-email: janandan@epri.com, yma@epri.com, wren@epri.com, pradatz@epri.com
License: BSD
Project-URL: Model Specification, https://www.epri.com/research/products/000000003002021694
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Utilities
Requires-Python: >=3.7
Description-Content-Type: text/x-rst
License-File: LICENSE.txt
Requires-Dist: numpy
Requires-Dist: matplotlib
Requires-Dist: pandas
Provides-Extra: dev
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'

Open-source Distributed Energy Resources (OpenDER) Model
========================================================
EPRI’s OpenDER model aims to properly represent steady-state and dynamic behavior of distributed energy resources
(DERs). The model follows interconnection standards or grid-codes and is informed by the observed behavior of
commercial products. Version 1.0 of the model assesses photovoltaic (PV) DER behavior according to the capabilities
and functionalities required by the IEEE standard 1547-2018. This first-of-its-kind model can be used to run snapshot,
Quasi-Static Time Series (QSTS), and a variety of dynamic analyses to study the impacts of DERs on distribution
operations and planning.

This project is licensed under the terms of the BSD-3 clause license.

|GitHub license|

.. |GitHub license| image:: https://img.shields.io/badge/License-BSD_3--Clause-blue.svg
   :target: https://github.com/epri-dev/opender/blob/master/LICENSE.txt


Resources
---------
OpenDER is under active development. Use the following resources to get involved.

* Model specification: IEEE 1547-2018 DER Model: Version 1.0, EPRI, Palo Alto, CA: 2021. 3002021694
  (`link <https://www.epri.com/research/products/000000003002021694>`__)

* EPRI OpenDER page (`link <https://www.epri.com/pages/sa/opender>`__ to be available)

* Readthedocs documentations (`link <https://opender.readthedocs.io/>`__)

Development Objective
---------------------
* Harmonize accurate interpretations of the IEEE Std 1547-2018 DER interconnection standard among stakeholders,
  including utilities, distribution analysis tool developers, and original equipment manufacturers (OEMs).

* Build consensus through an open-to-all DER Model User’s Group (DERMUG), which will utilize developed model
  specifications and codes and provide feedback for continuous improvement of the OpenDER model.

* Help the industry properly model the DERs that are (or to be) grid interconnected and evaluate the associated
  impacts on distribution circuits.

Overall Block Diagram
---------------------
.. figure:: https://raw.githubusercontent.com/epri-dev/OpenDER/develop/docs/blockdiagram.png
    :width: 900

Dependencies
------------
Python >= 3.7

numpy

pandas

matplotlib

Dependencies of the package are auto-installed by pip command below.

Installation
------------
pip install opender


Example of Using the DER Model
------------------------------
Example script: main.py

This example generate DER output power in a dynamic simulation to demonstrate DER trip and enter service behavior.

The grid voltage is set to be alternating between 1 and 1.11 per unit every ~10 minutes.

DER should be observed to enter service and trip periodically.

Please ensure python PATH is set in the environment variables before running the batch file

Unit tests
----------
Dependency: pytest

Execution command: pytest path-to-package\\tests




Changelog
=========

1.0.0 (2022-05-17)
------------------
* First release
* Model for photovoltaic (PV) DERs, including all smart inverter functions defined in IEEE Standard 1547-2018, as well as trip and enter service behaviors
* Output active and reactive power (P, Q) for power flow analysis
* Suitable for both steady-state, quasi-static time series (QSTS) and dynamic simulations


