.. _usage:

Usage
=====

Basic Usage
------------

To run the 'PowerDynamicEstimator', execute the `main.py` script from directory `pydynamicestimator`:

.. code-block:: bash

  python -m pydynamicestimator.main

Examples
--------

To get a feeling for different examples of the estimator, we prepared some short `./examples <https://gitlab.nccr-automation.ch/mkatanic/powerdynamicestimator/-/tree/main/examples?ref_type=heads>`_
to help you get started.

Basic Usage
^^^^^^^^^^^


See also all available test cases :ref:`test_cases`.

Modifying Configuration
------------------------

To adjust simulation and estimation parameters, you can modify the configuration object located in `./config.py` by calling the appropriate method. See :ref:`configuration`
for details.


.. _Kaggle Demo:

Kaggle Demo
-----------

You can try out the `PowerDynamicEstimator` package in an interactive Kaggle notebook:


.. image:: https://img.shields.io/badge/View%20on-Kaggle-blue?logo=kaggle
   :target: https://www.kaggle.com/code/miloskatanic/demo-estimator
   :alt: View on Kaggle











Advanced Usage
--------------

Refer to :ref:`advanced_usage` for more details regarding changing the system parameters, simulated disturbances, or PMU locations.