..  This file is part of Audio Tuner.

    Copyright 2025, 2026 Jessie Blue Cassell <bluesloth600@gmail.com>

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <https://www.gnu.org/licenses/>.

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

When you install Audio Tuner, you also get the ``audio_tuner`` Python package
with the following modules:

* :ref:`analysis <analysis>`
* :ref:`tuning_systems <tuning_systems>`
* :ref:`common <common>`
* :ref:`error_handling <error_handling>`

There's also the ``audio_tuner.argument_parser`` module, the
``audio_tuner.saved_options`` module (added in version 0.11) and the
``audio_tuner_gui`` package, which are not documented here but do include
docstrings in the source.

.. _analysis:

Analysis module
~~~~~~~~~~~~~~~

``audio_tuner.analysis``

.. automodule:: audio_tuner.analysis
   :members:

.. _tuning_systems:

Tuning Systems module
~~~~~~~~~~~~~~~~~~~~~

``audio_tuner.tuning_systems``

.. automodule:: audio_tuner.tuning_systems
   :members:

.. _common:

Common module
~~~~~~~~~~~~~

``audio_tuner.common``

.. automodule:: audio_tuner.common
   :members:

.. _error_handling:

Error Handling module
~~~~~~~~~~~~~~~~~~~~~

``audio_tuner.error_handling``

.. automodule:: audio_tuner.error_handling
   :members: