API Reference
=============

This page provides the autogenerated API reference for the public modules of
pyOMA-Monitoring.  Site-specific modules (``site_tower.py`` and similar) are
intentionally omitted from the public reference; see :doc:`configuration` for
the template-based guide to writing one.

.. contents:: Modules
   :local:
   :depth: 1


monitoring — engine functions
------------------------------

.. automodule:: monitoring
   :members: Site, register_site, get_site, set_active_site, get_active_site,
             read_file, get_file_info, create_file_info, get_stats, create_stats,
             get_modal_results, create_modal_results, get_slice, get_slice_corrected,
             get_slice_preprocessed, get_synchronized_time, get_file_list,
             describe_stats, compute_gap_lengths, close_to_utc_transition,
             round_dt, save_ds, split_modepairs, modal_analysis_single
   :undoc-members:
   :show-inheritance:


time_convention — timezone policy
-----------------------------------

.. automodule:: time_convention
   :members: TimeConvention, TC
   :undoc-members:
   :show-inheritance:


config — YAML loader
---------------------

.. automodule:: config
   :members: load_config, validate_config
   :undoc-members:
   :show-inheritance:


MultiLock — concurrent file access
------------------------------------

.. automodule:: MultiLock
   :members: MultiLock
   :undoc-members:
   :show-inheritance:


site_example — site template
------------------------------

.. automodule:: site_example
   :members:
   :undoc-members:
   :show-inheritance: