Installation Instructions
=========================

The package is directly installable via pip.

However, if you want to install from source or are planning to develop the code, please follow the instructions below.

.. note::

    A docker image is also available. Refer to :doc:`docker<docker>` page for details.


Install Git LFS
---------------

The test suite contains larger datasets versioned using the ``git-lfs`` extension which you will need.
On Debian/Ubuntu Linux:

.. code-block::

    sudo apt-get install git-lfs

Other installation methods are provided on the `Git LFS website <https://git-lfs.com/>`_.


Install the package
-------------------

Contributors should clone with SSH; the ``--recurse-submodules`` option ensures that the SKAO CI/CD Makefiles submodule is also pulled:

.. code-block:: text

    git clone --recurse-submodules git@gitlab.com/ska-telescope/sdp/science-pipeline-workflows/ska-sdp-wflow-pointing-offset.git

The package should be installed inside an isolated Python environment;
``poetry`` automatically creates one if its configuration parameter ``virtualenvs.create`` is ``true``.

.. code-block:: text

    poetry config virtualenvs.create true
    cd ska-sdp-wflow-pointing-offset/
    poetry install --all-extras

Note there are many alternatives available to manage Python environments (``uv``, ``conda``, etc.).