Skip to content

Commit

Permalink
Recommend use of Singularity/Apptainer
Browse files Browse the repository at this point in the history
  • Loading branch information
clelange committed Aug 9, 2023
1 parent eeb0b18 commit 36c3731
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions docs/setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,17 @@ If you are running on your own computer or laptop, it's up to you to decide wher

This setup naturally restricts you to use the latest stable version of the package in pypi. If you would like to use the code as it is the github repository, please follow the instructions in :ref:`sec-setup-developers`.

Using Singularity
Using Singularity/Apptainer
+++++++++++++++++++++++++++++++

On LXPLUS and many other local computing sites with CVMFS and Singularity available, you can use the library without having to install anything:
On LXPLUS and many other local computing sites with CVMFS and Singularity/Apptainer available, you can use the library without having to install anything:

::

singularity run /cvmfs/unpacked.cern.ch/ghcr.io/hepdata/hepdata_lib:latest /bin/bash
apptainer run /cvmfs/unpacked.cern.ch/ghcr.io/hepdata/hepdata_lib:latest /bin/bash

This opens a new shell with ``hepdata_lib``, ROOT, and Python 3 available.
Your home directory and most other user directories on the machine on which you execute Singularity will also be accessible from within this shell.
Your home directory and most other user directories on the machine on which you execute Singularity/Apptainer will also be accessible from within this shell.


.. _sec-setup-developers:
Expand Down Expand Up @@ -103,6 +103,12 @@ After running ``cmsenv``, you can check the installed version as follows:

::

python3 -m pip list | grep hepdata_lib
python3 -m pip list | grep hepdata-lib

(mind the use of ``hepdata-lib`` above, when importing, the package is still
called ``hepdata_lib``). If the version is significantly older than the one
on PyPI_, please use the Singularity/Apptainer container as described at
:ref:`sec-setup-users` above.

.. _cmsdist: https://github.com/cms-sw/cmsdist/
.. _PyPI: https://pypi.org/project/hepdata-lib/

0 comments on commit 36c3731

Please sign in to comment.