Installation
============

Windows and MacOS executables are available for all major releases on `GitHub <https://github.com/djdt/spcal/releases>`_.

To install SPCal via pip, first clone the repository, then install as a local package.

.. code-block::

    git clone https://github.com/djdt/spcal
    cd spcal
    pip install -e


The program can then be launched from the command line using ``spcal``.

For help, options and usage run ``spcal --help``.

.. note::
   Installation requires compilation of a C++ extension.
   For more information see the Python documentation on `Building C and C++ Extensions <https://docs.python.org/3/extending/building.html>`_ and `Building C and C++ Extensions on Windows <https://docs.python.org/3/extending/windows.html>`_.

.. note::
   From spcal version 2.0.0 onwards the `oneTBB <https://github.com/uxlfoundation/oneTBB>`_ C++ library is required.