https://github.com/singularityhub/singularity-hpc

Local filesystem registry for containers (intended for HPC) using Lmod or Environment Modules. Works for users and admins.
https://github.com/singularityhub/singularity-hpc

containers hpc lmod reproducibility singularity

Last synced: 9 months ago
JSON representation

Local filesystem registry for containers (intended for HPC) using Lmod or Environment Modules. Works for users and admins.

• Host: GitHub
• URL: https://github.com/singularityhub/singularity-hpc
• Owner: singularityhub
• License: mpl-2.0
• Created: 2021-04-02T20:52:30.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2025-04-12T04:32:20.000Z (10 months ago)
• Last Synced: 2025-05-03T04:38:51.960Z (9 months ago)
• Topics: containers, hpc, lmod, reproducibility, singularity
• Language: Python
• Homepage: https://singularity-hpc.readthedocs.io
• Size: 11.9 MB
• Stars: 118
• Watchers: 6
• Forks: 27
• Open Issues: 32
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Citation: CITATION.cff

Awesome Lists containing this project

README

          
# Singularity Registry HPC (shpc)

[![GitHub actions status](https://github.com/singularityhub/singularity-hpc/workflows/singularity-hpc/badge.svg?branch=main)](https://github.com/singularityhub/singularity-hpc/actions?query=branch%3Amain+workflow%3Asingularity-hpc)

[![DOI](https://zenodo.org/badge/354130612.svg)](https://zenodo.org/badge/latestdoi/354130612)

[![DOI](https://joss.theoj.org/papers/10.21105/joss.03311/status.svg)](https://doi.org/10.21105/joss.03311)

![https://raw.githubusercontent.com/singularityhub/singularity-hpc/main/docs/assets/img/shpc.png](https://raw.githubusercontent.com/singularityhub/singularity-hpc/main/docs/assets/img/shpc.png)

Singularity HPC is optimized for managing containers in an HPC environment. Currently, this includes

module technologies:

 - [Lmod](https://lmod.readthedocs.io/en/latest/)

 - [Environment Modules](http://modules.sourceforge.net/)

And container technologies:

 - [Singularity](https://github.com/sylabs/singularity)

 - [Podman](https://podman.io)

 - [Docker](https://docker.io)

You can use shpc if you are:

1. a linux administrator wanting to manage containers as modules for your cluster

2. a cluster user that wants to maintain your own folder of custom modules

3. a cluster user that simply wants to pull Singularity images as GitHub packages.

A module technology is required in all cases.

📖️ Read the [documentation](https://singularity-hpc.readthedocs.io/en/latest/) 📖️

⭐️ Browse the [container module collection](https://singularityhub.github.io/singularity-hpc/) ⭐️

## 😁️ Contributors 😁️

We use the [all-contributors](https://github.com/all-contributors/all-contributors)

tool to generate a contributors graphic below.

  

    

      
Vanessasaurus
💻

      
Daniel S. Katz
💻

      
Audrey Stott
💻

      
Alec Scott
💻

      
manbat
💻

      
Marco De La Pierre
💻

      
Alexandre Strube
💻

    

    

      
Xavier Delaruelle
💻

      
SarahBeecroft
💻

      
Matthieu Muffato
💻

      
Georgia Stuart
💻

      
Patrick Hüther
💻

      
Cristian Di Pietrantonio
💻

      
amjad
💻

    

  

## 🎨️ Previous Art 🎨️

There are other tools that you might be interested in!

 - [VA Research Computing](https://www.rc.virginia.edu/userinfo/rivanna/software/containers/) has a similar system, but I couldn't find any code.

 - [Community Collections](https://github.com/community-collections/community-collections)

 - [Spack](https://spack.readthedocs.io/en/latest/module_file_support.html) installs modules for software built from source (not containers).

## License

This code is licensed under the MPL 2.0 [LICENSE](LICENSE).