pydynamicestimator.config
=========================

.. py:module:: pydynamicestimator.config


Attributes
----------

.. autoapisummary::

   pydynamicestimator.config.IntegrationSchemaEst
   pydynamicestimator.config.IntegrationSchemeSim
   pydynamicestimator.config.Frequency
   pydynamicestimator.config.Filter
   pydynamicestimator.config.Levels
   pydynamicestimator.config.base_dir
   pydynamicestimator.config.config


Classes
-------

.. autoapisummary::

   pydynamicestimator.config.Config


Module Contents
---------------

.. py:data:: IntegrationSchemaEst

.. py:data:: IntegrationSchemeSim

.. py:data:: Frequency

.. py:data:: Filter

.. py:data:: Levels

.. py:class:: Config(/, **data: Any)

   Bases: :py:obj:`pydantic.BaseModel`


   Configuration class used to store all relevant attributes for the execution of
   simulation and estimation.


   .. py:attribute:: testsystemfile
      :type:  pathlib.Path


   .. py:attribute:: fn
      :type:  Frequency


   .. py:attribute:: Sb
      :type:  int


   .. py:attribute:: ts
      :type:  float


   .. py:attribute:: te
      :type:  float


   .. py:attribute:: T_start
      :type:  float


   .. py:attribute:: T_end
      :type:  float


   .. py:attribute:: filter
      :type:  Filter


   .. py:attribute:: int_scheme
      :type:  IntegrationSchemaEst


   .. py:attribute:: int_scheme_sim
      :type:  IntegrationSchemeSim


   .. py:attribute:: init_error_diff
      :type:  float


   .. py:attribute:: init_error_alg
      :type:  bool


   .. py:attribute:: plot
      :type:  bool


   .. py:attribute:: plot_voltage
      :type:  bool


   .. py:attribute:: plot_diff
      :type:  bool


   .. py:attribute:: proc_noise_alg
      :type:  float


   .. py:attribute:: proc_noise_diff
      :type:  float


   .. py:attribute:: incl_lim
      :type:  bool


   .. py:attribute:: log_level
      :type:  Levels


   .. py:method:: updated(**kwargs: Any) -> Config

        All keyword arguments listed below are optional and can be used to customize the configuration.

      :param testsystemfile: The path to the system test case.
      :type testsystemfile: str

      :param fn: System frequency (currently only tested for 50 Hz).
      :type fn: float

      :param Sb: Base power of the grid in [MW]. Line parameters are assumed to be calculated using this base power.
      :type Sb: float

      :param ts: Simulation time step.
      :type ts: float

      :param te: Estimation time step. Must be greater than or equal to the simulation time step.
      :type te: float

      :param T_start: Estimation start time (must currently be 0).
      :type T_start: float

      :param T_end: End time of the simulation/estimation.
      :type T_end: float

      :param int_scheme: Integration scheme for the estimation. Must be `'trapezoidal'` or `'backward'`.
      :type int_scheme: str

      :param init_error_diff: Estimation initialization error for differential states. E.g., `1.0` corresponds to 10% error.
      :type init_error_diff: float

      :param init_error_alg: Whether to use a flat start (`True`) or true values (`False`) for initialization.
      :type init_error_alg: bool

      :param plot: Enable or disable plotting.
      :type plot: bool

      :param plot_voltage: Whether to plot voltage data.
      :type plot_voltage: bool

      :param plot_diff: Whether to plot differential state data.
      :type plot_diff: bool

      :param proc_noise_alg: Process noise for the algebraic equations. Default is `1e-3`.
      :type proc_noise_alg: float

      :param proc_noise_diff: Process noise for the differential equations. Default is `1e-4`.
      :type proc_noise_diff: float

      :param incl_lim: If state limiters should be included in the simulation and the estimation. If `False`, the simulation will be much faster.
      :type incl_lim: bool

      :returns: A new instance of the :class:`Config` class configured with the provided parameters.
      :rtype: Config



   .. py:method:: get_log_level()

      Returns the log level.



.. py:data:: base_dir

.. py:data:: config