.. Indar documentation master file, created by
   sphinx-quickstart on Thu May  7 08:41:42 2026.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Indar Documentation
===================

**Version:** |version|

**Date:** |today|

**Links:**
`Source repository <https://github.com/CFAA-EHU/bcam-indar>`_ \|
`Issues <https://github.com/CFAA-EHU/bcam-indar/issues>`_

Indar (from the Basque word for *force*) is an open-source Python package created by researchers at
the `Basque Center for Applied Mathematics <https://www.bcamath.org/en>`_ (BCAM)
to share algorithms and tools developed during their research in the field of machine tool vibration and
monitoring of machining processes.

To install Indar, you can use pip:

.. code-block:: bash

   pip install bcam-indar

As usual, we recommend installing Indar in a virtual environment using tools such as
`Mamba <https://mamba.readthedocs.io/en/latest/index.html>`_.

.. toctree::
   :maxdepth: 1
   :caption: Contents:
   
   Getting started <getting_started>
   API Reference <api_reference>