.. _installation:

************
Installation
************

Prerequisites
=============

pipx
----

``pipx`` is a **very** useful tool to install and run Python applications in isolated environments.
If you do not have it already, `please follow the installation instructions here <https://github.com/pypa/pipx>`_.
Verify the installation is successful by running:

.. code-block::

    pipx --version

poetry
------

``poetry`` is the official Python package manager for SKAO repositories.
You can install it easily with ``pipx``:

.. code-block:: text

    pipx install poetry

Verify the installation is successful by running:

.. code-block::

    poetry --version


Installing the batch pre-processing pipeline
============================================

.. note::

    If you plan on developing, please first read :ref:`devguide`.


Clone the repository
---------------------

Navigate to the parent directory of your choice and run:

.. code-block:: text

    git clone https://gitlab.com/ska-telescope/sdp/science-pipeline-workflows/ska-sdp-batch-preprocess.git


Create a Python environment
---------------------------

It is highly recommended to install the pipeline inside a dedicated environment. Poetry will create
one automatically if its configuration parameter ``virtualenvs.create`` is ``true``.

.. code-block:: text

    poetry config virtualenvs.create true
    cd ska-sdp-batch-preprocess/
    poetry install

The pipeline and its dependencies should now be installed in a ``.venv/`` sub-directory.


Activate the environment and verify the installation
----------------------------------------------------

The environment we just created needs to be activated so that the pipeline application(s) become
available globally in our terminal:

.. code-block:: text

    source .venv/bin/activate

Verify that you can now run:

.. code-block:: text

    ska-sdp-batch-preprocess --version