Install
=======

SingularityCE_ is generally not available in most package managers
(e.g. not available on Ubuntu via ``apt`` nor ``apt-get``)
and usually requires to be compiled from source.

From source
-----------

The broad idea is the following:

1. Install dependencies

2. Install recent Go_ version from official binaries

3. Download SingularityCE_ source code

4. Compile SingularityCE_

5. Install compiled SingularityCE_ **as root**

.. seealso::

    For more information: `SingularityCE - Quick Installation Steps`_.

From releases
-------------

Some releases are however available on GitHub: `SingularityCE GitHub
releases`_ for some Linux distributions but not much documentation
is available regarding this topic. These releases might also require
a recent Go_ version for various dependency reasons.

| Nix_ however does provide a ``singularity`` package if needed.
| If using Nix_ some options might need some tweaking.

.. note::

    On the contrary Apptainer_ usually
    is available as pre-built packages.

    See `Apptainer - Install from pre-built
    packages`_ for more information.

    If using Nix_: see `Apptainer - Non standard
    environments`_ for more information.

.. Links
.. _Apptainer: https://apptainer.org/
.. _Apptainer - Install from pre-built packages: https://apptainer.org/docs/admin/main/installation.html#install-from-pre-built-packages
.. _Apptainer - Non standard environments: https://apptainer.org/docs/admin/main/installation.html#non-standard-ldconfig-nix-guix-environments
.. _Go: https://go.dev/
.. _Nix: https://en.wikipedia.org/wiki/Nix_(package_manager)
.. _Project-Rat: https://gitlab.com/project-rat
.. _PRE Docs: https://gitlab.com/project-rat-extras/docs
.. _Rat-Docs: https://gitlab.com/project-rat/rat-documentation
.. _Rat-Containers: https://gitlab.com/project-rat-extras/rat-containers
.. _rat-containers/singularity: https://gitlab.com/project-rat-extras/rat-containers/-/blob/main/singularity/
.. _SingularityCE: https://sylabs.io/singularity/
.. _SingularityCE Definition File: https://docs.sylabs.io/guides/4.4/user-guide/definition_files.html
.. _SingularityCE Definition Files: https://docs.sylabs.io/guides/4.4/user-guide/definition_files.html
.. _SingularityCE GitHub releases: https://github.com/sylabs/singularity/releases
.. _SingularityCE preferred bootstrap agents: https://docs.sylabs.io/guides/4.3/user-guide/definition_files.html#preferred-bootstrap-agents
.. _SingularityCE - Quick Installation Steps: https://docs.sylabs.io/guides/4.3/user-guide/quick_start.html#quick-installation-steps