First steps
==================================

Prerequisites
----------------------------------

This software is shipped as **python3** package, therefore you need to have python3
and pip installed. If not, please check `pip documentation`_ to find out how to
install and run **pip** in your system with at least the following versions:

    =============  ===============
     software       version
    =============  ===============
     python         >= 3.6.12
     pip            >= 21.0.1
    =============  ===============

.. note:: Non admin rights? Check how to run conda_ in your machine.

.. _`pip documentation`: https://indigo-dc.gitbook.io/udocke
.. _conda: https://docs.conda.io/en/latest


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

Once **python3** and **pip** are running in your system, download the package and
install it using pip:

.. code-block:: bash

    $ git clone https://git.scc.kit.edu/synergy.o3as/o3skim.git
    Cloning into 'o3skim'...
    ...
    $ cd o3skim 
    $ pip install .
    ...
    Successfully installed o3skim-0.4.0