# Singularity Registry HPC (shpc)
[](https://github.com/singularityhub/singularity-hpc/actions?query=branch%3Amain+workflow%3Asingularity-hpc)
[](https://zenodo.org/badge/latestdoi/354130612)
[](https://doi.org/10.21105/joss.03311)
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.
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tbody>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://vsoch.github.io"><img src="https://avatars.githubusercontent.com/u/814322?v=4?s=100" width="100px;" alt="Vanessasaurus"/><br /><sub><b>Vanessasaurus</b></sub></a><br /><a href="https://github.com/singularityhub/singularity-hpc/commits?author=vsoch" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/danielskatz"><img src="https://avatars.githubusercontent.com/u/2913845?v=4?s=100" width="100px;" alt="Daniel S. Katz"/><br /><sub><b>Daniel S. Katz</b></sub></a><br /><a href="https://github.com/singularityhub/singularity-hpc/commits?author=danielskatz" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/audreystott"><img src="https://avatars.githubusercontent.com/u/43943628?v=4?s=100" width="100px;" alt="Audrey Stott"/><br /><sub><b>Audrey Stott</b></sub></a><br /><a href="https://github.com/singularityhub/singularity-hpc/commits?author=audreystott" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="alecbcs.com"><img src="https://avatars.githubusercontent.com/u/19558067?v=4?s=100" width="100px;" alt="Alec Scott"/><br /><sub><b>Alec Scott</b></sub></a><br /><a href="https://github.com/singularityhub/singularity-hpc/commits?author=alecbcs" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/manbat"><img src="https://avatars.githubusercontent.com/u/41646490?v=4?s=100" width="100px;" alt="manbat"/><br /><sub><b>manbat</b></sub></a><br /><a href="https://github.com/singularityhub/singularity-hpc/commits?author=manbat" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/marcodelapierre"><img src="https://avatars.githubusercontent.com/u/16972180?v=4?s=100" width="100px;" alt="Marco De La Pierre"/><br /><sub><b>Marco De La Pierre</b></sub></a><br /><a href="https://github.com/singularityhub/singularity-hpc/commits?author=marcodelapierre" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="http://surak.wordpress.com"><img src="https://avatars.githubusercontent.com/u/878399?v=4?s=100" width="100px;" alt="Alexandre Strube"/><br /><sub><b>Alexandre Strube</b></sub></a><br /><a href="https://github.com/singularityhub/singularity-hpc/commits?author=surak" title="Code">💻</a></td>
</tr>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/xdelaruelle"><img src="https://avatars.githubusercontent.com/u/4928853?v=4?s=100" width="100px;" alt="Xavier Delaruelle"/><br /><sub><b>Xavier Delaruelle</b></sub></a><br /><a href="https://github.com/singularityhub/singularity-hpc/commits?author=xdelaruelle" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/SarahBeecroft"><img src="https://avatars.githubusercontent.com/u/16343767?v=4?s=100" width="100px;" alt="SarahBeecroft"/><br /><sub><b>SarahBeecroft</b></sub></a><br /><a href="https://github.com/singularityhub/singularity-hpc/commits?author=SarahBeecroft" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://muffato.github.io"><img src="https://avatars.githubusercontent.com/u/623458?v=4?s=100" width="100px;" alt="Matthieu Muffato"/><br /><sub><b>Matthieu Muffato</b></sub></a><br /><a href="https://github.com/singularityhub/singularity-hpc/commits?author=muffato" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/georgiastuart"><img src="https://avatars.githubusercontent.com/u/8276147?v=4?s=100" width="100px;" alt="Georgia Stuart"/><br /><sub><b>Georgia Stuart</b></sub></a><br /><a href="https://github.com/singularityhub/singularity-hpc/commits?author=georgiastuart" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://orcid.org/0000-0003-3315-2484"><img src="https://avatars.githubusercontent.com/u/2433146?v=4?s=100" width="100px;" alt="Patrick Hüther"/><br /><sub><b>Patrick Hüther</b></sub></a><br /><a href="https://github.com/singularityhub/singularity-hpc/commits?author=phue" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/dipietrantonio"><img src="https://avatars.githubusercontent.com/u/2136256?v=4?s=100" width="100px;" alt="Cristian Di Pietrantonio"/><br /><sub><b>Cristian Di Pietrantonio</b></sub></a><br /><a href="https://github.com/singularityhub/singularity-hpc/commits?author=dipietrantonio" title="Code">💻</a></td>
</tr>
</tbody>
</table>
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
## 🎨️ 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).
Raw data
{
"_id": null,
"home_page": "https://github.com/singularityhub/singularity-hpc",
"name": "singularity-hpc",
"maintainer": "Vanessa Sochat",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "singularity,containers,hpc,lmd",
"author": "Vanessa Sochat",
"author_email": "vsoch@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/29/53/5ee9d86b7d066be5b8513f067fd28ce994742247cce541a6c1879e7543f0/singularity-hpc-0.1.28.tar.gz",
"platform": null,
"description": "# Singularity Registry HPC (shpc)\n\n[](https://github.com/singularityhub/singularity-hpc/actions?query=branch%3Amain+workflow%3Asingularity-hpc)\n[](https://zenodo.org/badge/latestdoi/354130612)\n[](https://doi.org/10.21105/joss.03311)\n\n\n\nSingularity HPC is optimized for managing containers in an HPC environment. Currently, this includes\nmodule technologies:\n\n - [Lmod](https://lmod.readthedocs.io/en/latest/)\n - [Environment Modules](http://modules.sourceforge.net/)\n\nAnd container technologies:\n\n - [Singularity](https://github.com/sylabs/singularity)\n - [Podman](https://podman.io)\n - [Docker](https://docker.io)\n\n\nYou can use shpc if you are:\n\n1. a linux administrator wanting to manage containers as modules for your cluster\n2. a cluster user that wants to maintain your own folder of custom modules\n3. a cluster user that simply wants to pull Singularity images as GitHub packages.\n\nA module technology is required in all cases.\n\n\ud83d\udcd6\ufe0f Read the [documentation](https://singularity-hpc.readthedocs.io/en/latest/) \ud83d\udcd6\ufe0f\n\u2b50\ufe0f Browse the [container module collection](https://singularityhub.github.io/singularity-hpc/) \u2b50\ufe0f\n\n## \ud83d\ude01\ufe0f Contributors \ud83d\ude01\ufe0f\n\nWe use the [all-contributors](https://github.com/all-contributors/all-contributors)\ntool to generate a contributors graphic below.\n\n<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->\n<!-- prettier-ignore-start -->\n<!-- markdownlint-disable -->\n<table>\n <tbody>\n <tr>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://vsoch.github.io\"><img src=\"https://avatars.githubusercontent.com/u/814322?v=4?s=100\" width=\"100px;\" alt=\"Vanessasaurus\"/><br /><sub><b>Vanessasaurus</b></sub></a><br /><a href=\"https://github.com/singularityhub/singularity-hpc/commits?author=vsoch\" title=\"Code\">\ud83d\udcbb</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/danielskatz\"><img src=\"https://avatars.githubusercontent.com/u/2913845?v=4?s=100\" width=\"100px;\" alt=\"Daniel S. Katz\"/><br /><sub><b>Daniel S. Katz</b></sub></a><br /><a href=\"https://github.com/singularityhub/singularity-hpc/commits?author=danielskatz\" title=\"Code\">\ud83d\udcbb</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/audreystott\"><img src=\"https://avatars.githubusercontent.com/u/43943628?v=4?s=100\" width=\"100px;\" alt=\"Audrey Stott\"/><br /><sub><b>Audrey Stott</b></sub></a><br /><a href=\"https://github.com/singularityhub/singularity-hpc/commits?author=audreystott\" title=\"Code\">\ud83d\udcbb</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"alecbcs.com\"><img src=\"https://avatars.githubusercontent.com/u/19558067?v=4?s=100\" width=\"100px;\" alt=\"Alec Scott\"/><br /><sub><b>Alec Scott</b></sub></a><br /><a href=\"https://github.com/singularityhub/singularity-hpc/commits?author=alecbcs\" title=\"Code\">\ud83d\udcbb</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/manbat\"><img src=\"https://avatars.githubusercontent.com/u/41646490?v=4?s=100\" width=\"100px;\" alt=\"manbat\"/><br /><sub><b>manbat</b></sub></a><br /><a href=\"https://github.com/singularityhub/singularity-hpc/commits?author=manbat\" title=\"Code\">\ud83d\udcbb</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/marcodelapierre\"><img src=\"https://avatars.githubusercontent.com/u/16972180?v=4?s=100\" width=\"100px;\" alt=\"Marco De La Pierre\"/><br /><sub><b>Marco De La Pierre</b></sub></a><br /><a href=\"https://github.com/singularityhub/singularity-hpc/commits?author=marcodelapierre\" title=\"Code\">\ud83d\udcbb</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"http://surak.wordpress.com\"><img src=\"https://avatars.githubusercontent.com/u/878399?v=4?s=100\" width=\"100px;\" alt=\"Alexandre Strube\"/><br /><sub><b>Alexandre Strube</b></sub></a><br /><a href=\"https://github.com/singularityhub/singularity-hpc/commits?author=surak\" title=\"Code\">\ud83d\udcbb</a></td>\n </tr>\n <tr>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/xdelaruelle\"><img src=\"https://avatars.githubusercontent.com/u/4928853?v=4?s=100\" width=\"100px;\" alt=\"Xavier Delaruelle\"/><br /><sub><b>Xavier Delaruelle</b></sub></a><br /><a href=\"https://github.com/singularityhub/singularity-hpc/commits?author=xdelaruelle\" title=\"Code\">\ud83d\udcbb</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/SarahBeecroft\"><img src=\"https://avatars.githubusercontent.com/u/16343767?v=4?s=100\" width=\"100px;\" alt=\"SarahBeecroft\"/><br /><sub><b>SarahBeecroft</b></sub></a><br /><a href=\"https://github.com/singularityhub/singularity-hpc/commits?author=SarahBeecroft\" title=\"Code\">\ud83d\udcbb</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://muffato.github.io\"><img src=\"https://avatars.githubusercontent.com/u/623458?v=4?s=100\" width=\"100px;\" alt=\"Matthieu Muffato\"/><br /><sub><b>Matthieu Muffato</b></sub></a><br /><a href=\"https://github.com/singularityhub/singularity-hpc/commits?author=muffato\" title=\"Code\">\ud83d\udcbb</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/georgiastuart\"><img src=\"https://avatars.githubusercontent.com/u/8276147?v=4?s=100\" width=\"100px;\" alt=\"Georgia Stuart\"/><br /><sub><b>Georgia Stuart</b></sub></a><br /><a href=\"https://github.com/singularityhub/singularity-hpc/commits?author=georgiastuart\" title=\"Code\">\ud83d\udcbb</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://orcid.org/0000-0003-3315-2484\"><img src=\"https://avatars.githubusercontent.com/u/2433146?v=4?s=100\" width=\"100px;\" alt=\"Patrick H\u00fcther\"/><br /><sub><b>Patrick H\u00fcther</b></sub></a><br /><a href=\"https://github.com/singularityhub/singularity-hpc/commits?author=phue\" title=\"Code\">\ud83d\udcbb</a></td>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/dipietrantonio\"><img src=\"https://avatars.githubusercontent.com/u/2136256?v=4?s=100\" width=\"100px;\" alt=\"Cristian Di Pietrantonio\"/><br /><sub><b>Cristian Di Pietrantonio</b></sub></a><br /><a href=\"https://github.com/singularityhub/singularity-hpc/commits?author=dipietrantonio\" title=\"Code\">\ud83d\udcbb</a></td>\n </tr>\n </tbody>\n</table>\n\n<!-- markdownlint-restore -->\n<!-- prettier-ignore-end -->\n\n<!-- ALL-CONTRIBUTORS-LIST:END -->\n\n\n## \ud83c\udfa8\ufe0f Previous Art \ud83c\udfa8\ufe0f\n\nThere are other tools that you might be interested in!\n\n - [VA Research Computing](https://www.rc.virginia.edu/userinfo/rivanna/software/containers/) has a similar system, but I couldn't find any code.\n - [Community Collections](https://github.com/community-collections/community-collections)\n - [Spack](https://spack.readthedocs.io/en/latest/module_file_support.html) installs modules for software built from source (not containers).\n\n## License\n\nThis code is licensed under the MPL 2.0 [LICENSE](LICENSE).\n",
"bugtrack_url": null,
"license": "LICENSE",
"summary": "Local registry intended for HPC using containers and system modules.",
"version": "0.1.28",
"project_urls": {
"Homepage": "https://github.com/singularityhub/singularity-hpc"
},
"split_keywords": [
"singularity",
"containers",
"hpc",
"lmd"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "57651ad0b050a1abf6dab01e7ad451b3b752a84127b935c894da49ee3bda0ff5",
"md5": "051aee2832b67cfd71e0966f94ee17de",
"sha256": "bf3c8b0b038cead1555ba3333c0feffcb6c0fbfa2c59304649828e3027e1ab6c"
},
"downloads": -1,
"filename": "singularity_hpc-0.1.28-py3-none-any.whl",
"has_sig": false,
"md5_digest": "051aee2832b67cfd71e0966f94ee17de",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 130155,
"upload_time": "2024-03-18T16:38:43",
"upload_time_iso_8601": "2024-03-18T16:38:43.268216Z",
"url": "https://files.pythonhosted.org/packages/57/65/1ad0b050a1abf6dab01e7ad451b3b752a84127b935c894da49ee3bda0ff5/singularity_hpc-0.1.28-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "29535ee9d86b7d066be5b8513f067fd28ce994742247cce541a6c1879e7543f0",
"md5": "12b6e8959d11da8f51f1a83b0cbef1a2",
"sha256": "d1a83fa12fefb40bcd311cef7332a34e52b8159405978043a65b02a65a881505"
},
"downloads": -1,
"filename": "singularity-hpc-0.1.28.tar.gz",
"has_sig": false,
"md5_digest": "12b6e8959d11da8f51f1a83b0cbef1a2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 132758,
"upload_time": "2024-03-18T16:38:45",
"upload_time_iso_8601": "2024-03-18T16:38:45.131471Z",
"url": "https://files.pythonhosted.org/packages/29/53/5ee9d86b7d066be5b8513f067fd28ce994742247cce541a6c1879e7543f0/singularity-hpc-0.1.28.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-18 16:38:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "singularityhub",
"github_project": "singularity-hpc",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "singularity-hpc"
}
JSON
