Skip to content

Commit

Permalink
Document Singularity requirements (#805)
Browse files Browse the repository at this point in the history
  • Loading branch information
tsalo authored Feb 15, 2023
1 parent 99798ed commit f98190f
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ assignees: ''
## Additional details
<!--Please fill in the following details-->
- xcp_d version:
- Docker version:
- Singularity version:

### What were you trying to do?

Expand Down
7 changes: 7 additions & 0 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,13 @@ Running ``xcp_d`` via Singularity containers
If you are computing on an :abbr:`HPC (High-Performance Computing)`, we recommend using Singularity.
See :ref:`installation_container_technologies` for installation instructions.

.. warning::

``xcp_d`` (and perhaps other Docker-based Singularity images) may not work with Singularity <=2.4.
We strongly recommend using Singularity 3+.
For more information, see `this xcp_d issue <https://github.com/PennLINC/xcp_d/issues/793>`_ and
`this Singularity issue <https://github.com/apptainer/singularity/issues/884>`_.

If the data to be preprocessed is also on the HPC or a personal computer, you are ready to run *xcp_d*.

.. code-block:: bash
Expand Down

0 comments on commit f98190f

Please sign in to comment.