Skip to content

Commit

Permalink
Add Singularity documentation (#195)
Browse files Browse the repository at this point in the history
  • Loading branch information
clelange authored Feb 18, 2022
1 parent 0eb8b2c commit 4a65a17
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ Setup
Setup for users
-----------------

With Python 3 locally available
+++++++++++++++++++++++++++++++

The library is available for installation as a pypi package and can be installed from the terminal with pip:


Expand All @@ -19,6 +22,18 @@ 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
+++++++++++++++++++++++++++++++

On LXPLUS and many other local computing sites with CVMFS and Singularity 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

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.


.. _sec-setup-developers:

Expand Down

0 comments on commit 4a65a17

Please sign in to comment.