===============
Getting Started
===============

Installation
------------

`sg_audio` Package
^^^^^^^^^^^^^^^^^^

Install the `sg_audio` package using the following commands:

.. code-block:: bash

    git clone git@gitlab.fhnw.ch:swissai/apertus/sg_audio.git
    cd sg_audio
    pip install -e .

To generate documentation, for linting and testing the optional `dev` dependencies are
required.

To install the package *with* the optional `dev` dependencies use the folloging command:

.. code-block:: bash

    pip install -e .[dev]

The `-e` stands for "editable", meaning that changes to the source code files are 
directly applied and there is no need to reinstall the package for every chage.

Pre Commit Hooks
^^^^^^^^^^^^^^^^
For contributing to the code base please also install the pre-commit hooks. Pre commit
hooks are run before staged code is committed. The configured pre commit hooks make sure
the code follows the guidelines of the repository as defined by the continuous 
integration pipeline.

Install `pre-commit` program using `pip`:

.. code-block:: bash

    pip install pre-commit

Activate the `pre-commit` hooks in the git repository:

.. code-block:: bash

    pre-commit install