hermess.config
==============

.. py:module:: hermess.config


Attributes
----------

.. autoapisummary::

   hermess.config.IntegrationSchemeSim
   hermess.config.Frequency
   hermess.config.Levels
   hermess.config.Reference
   hermess.config.config


Classes
-------

.. autoapisummary::

   hermess.config.Config


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

.. py:data:: IntegrationSchemeSim

.. py:data:: Frequency

.. py:data:: Levels

.. py:data:: Reference

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

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


   Holds all attributes controlling a simulation run.


   .. py:attribute:: testsystemfile
      :type:  str


   .. py:attribute:: system_root
      :type:  pathlib.Path | None
      :value: None



   .. py:attribute:: omega_mode
      :type:  Reference


   .. py:attribute:: omega_single_idx
      :type:  str | None
      :value: None



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


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


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


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


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


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


   .. py:attribute:: int_scheme_sim_options
      :type:  dict


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


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


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


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


   .. py:attribute:: line_dyn
      :type:  bool


   .. py:attribute:: skip_disturance
      :type:  bool


   .. py:attribute:: debug_check_init
      :type:  bool


   .. py:attribute:: print_power_flow
      :type:  bool


   .. py:attribute:: small_signal_analysis
      :type:  bool
      :value: False



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


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

      Return a copy of this config with the given fields overridden.

      :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 omega_mode: Reference frequency mode used in the simulation. Must be `'coi'`, `'single'`, `'nom'` or `'dist'`.
      :type omega_mode: str

      :param omega_single_idx: Reference device identifier (e.g. `"SG1"`) used only if `omega_mode='single'` (None → slack bus).
      :type omega_single_idx: str or None

      :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 T_start: Simulation start time (must currently be 0).
      :type T_start: float

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

      :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 incl_lim: If state limiters should be included in the simulation. If `False`, the simulation will be much faster.
      :type incl_lim: bool

      :param line_dyn: Simulate with line dynamic models (differential equations).
      :type line_dyn: bool

      :param skip_disturance: Skip disturbance simulation.
      :type skip_disturance: bool

      :param debug_check_init: Enable debug check for initialization of DAE system.
      :type debug_check_init: bool

      :param print_power_flow: Print initial power flow to output.
      :type print_power_flow: bool

      :param small_signal_analysis: Run the small-signal eigenvalue/participation
          analysis at the operating point (before the simulation) and show the
          frequency-banded participation figures plus the modal report.
      :type small_signal_analysis: 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:: config