.. PowerDynamicEstimator documentation master file, created by
   sphinx-quickstart on Mon Jan 20 16:01:21 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

PowerDynamicEstimator
=====================



`PowerDynamicEstimator` is a dynamic state estimation (DSE) tool for power systems using the recursive Iterated Extended Kalman Filter (IEKF).
It is designed for nonlinear differential-algebraic equation power system models and handles incomplete modeling information.

For example, loads and generators can have unknown models. In such cases, their original models are used to simulate the behavior
of the system, but the models are considered unavailable to the Kalman filter. Moreover, the network topology and parameters may be
unknown as well; only a subpart (subgrid) of the system needs to be available to the estimator.

This feature mimics the realistic situation where different stakeholders operating different areas of the power system are not
exchanging information between each other due to for example privacy reasons.

.. admonition:: Key advantages
   :class: note

   - **Kalman filtering-based** – Provides an optimal recursive estimation method.
   - **Handles incomplete nonlinear DAE models** – Works even when some system components are unknown.
   - **Integrates multiple data sources** – Combines **dynamic evolution equations, algebraic network equations,** and **phasor measurements**.
   - **Renewables included** - Grid-following and grid-forming inverter models included
   - **Flexible model handling** – Allows straightforward **dynamic and static model updates** and easy **test configuration changes**.

For technical details, see our `Paper <https://arxiv.org/abs/2305.10065v2>`_.

Refer to the :ref:`installation` section to get started!



.. toctree::
   :maxdepth: 1
   :caption: Contents

   installation
   usage
   advanced_usage
   configuration
   cases
   models
   models_static
   license

Project Structure
=================

.. literalinclude:: project_tree.txt
   :language: none
   :encoding: utf-8

Indices and Tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

Citation
========

If you use ``PowerDynamicEstimator`` in your research, please cite our paper:


.. code-block:: bibtex

    @article{powerdynamicestimator,
      author = {Katanic, Milos and Lygeros, John and Hug, Gabriela},
      title = {Recursive dynamic state estimation for power systems with an incomplete nonlinear DAE model},
      journal = {IET Generation, Transmission \& Distribution},
      volume = {18},
      number = {22},
      pages = {3657-3668},
      keywords = {differential algebraic equations, Kalman filters, state estimation},
      doi = {https://doi.org/10.1049/gtd2.13308},
      url = {https://ietresearch.onlinelibrary.wiley.com/doi/abs/10.1049/gtd2.13308},
      eprint = {https://ietresearch.onlinelibrary.wiley.com/doi/pdf/10.1049/gtd2.13308},
      year = {2024}
    }

Contact and Contributing
========================

If you have any questions, want to signal an error or contribute to the project,
feel free to reach out to Milos Katanic via email: mkatanic@ethz.ch