.. Copyright 2023 Sandia National Laboratories, LLC
   (c.f. AUTHORS, NOTICE.LLNS, COPYING)

   SPDX-License-Identifier: (LGPL-3.0)

.. OVIS-HPC documentation master file, created by
   sphinx-quickstart on Fri Jan 10 15:11:07 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome To OVIS LDMS Documentation!
====================================
.. image:: https://github.com/ovis-hpc/readthedocs/blob/main/images/ovis-logo.png?raw=true
   :target: https://ovis-hpc.readthedocs.io/en/latest/index.html
   :width: 225
   :height: 250
   :align: center

LDMS is a lightweight framework for collecting, aggregating, and transporting system metrics in HPC environments. It gathers data from diverse sources like hardware counters and system logs, enabling real-time monitoring with low overhead and scalability for large systems.

.. toctree::
   :maxdepth: 3
   :caption: Introduction To LDMS

   intro/quick-start

.. toctree::
   :maxdepth: 3
   :caption: LDMS Streams

   streams/ldms-streams-apps

.. toctree::
   :maxdepth: 3
   :caption: ASF

   asf/index

.. toctree::
   :maxdepth: 3
   :caption: Deployment

   deployment/index

.. toctree::
   :maxdepth: 3
   :caption: Man Pages

   rst_man/index

.. toctree::
   :maxdepth: 2
   :caption: Contributing to LDMS

   contributing/index

To join the LDMS Users Group Mailing List: https://github.com/ovis-hpc/ovis-wiki/wiki/Mailing-Lists

OVIS Subproject Github Repositories
====================================

* `ldms <https://github.com/ovis-hpc/ovis>`_
* `ovis-publications <https://github.com/ovis-hpc/ovis-publications>`_
* `maestro <https://github.com/ovis-hpc/maestro>`_
* `sos <https://github.com/ovis-hpc/sos>`_
* `baler <https://github.com/ovis-hpc/baler>`_
* `containers <https://github.com/ovis-hpc/ldms-containers>`_
* `ovis-publications <https://github.com/ovis-hpc/ovis-publications>`_