singularity-hpc


Namesingularity-hpc JSON
Version 0.1.31 PyPI version JSON
download
home_pagehttps://github.com/singularityhub/singularity-hpc
SummaryLocal registry intended for HPC using containers and system modules.
upload_time2025-01-11 21:02:24
maintainerVanessa Sochat
docs_urlNone
authorVanessa Sochat
requires_pythonNone
licenseLICENSE
keywords singularity containers hpc lmd
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # 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.

<!-- 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>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Amjadhpc"><img src="https://avatars.githubusercontent.com/u/1035011?v=4?s=100" width="100px;" alt="amjad"/><br /><sub><b>amjad</b></sub></a><br /><a href="https://github.com/singularityhub/singularity-hpc/commits?author=Amjadhpc" 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": null,
    "maintainer_email": null,
    "keywords": "singularity, containers, hpc, lmd",
    "author": "Vanessa Sochat",
    "author_email": "vsoch@users.noreply.github.com",
    "download_url": "https://files.pythonhosted.org/packages/bb/0c/c9227f18531ae317ff125c014f4c2da02431ea9704fc82f4f61e782d1466/singularity_hpc-0.1.31.tar.gz",
    "platform": null,
    "description": "# Singularity Registry HPC (shpc)\n\n[![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)\n[![DOI](https://zenodo.org/badge/354130612.svg)](https://zenodo.org/badge/latestdoi/354130612)\n[![DOI](https://joss.theoj.org/papers/10.21105/joss.03311/status.svg)](https://doi.org/10.21105/joss.03311)\n\n![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)\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      <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/Amjadhpc\"><img src=\"https://avatars.githubusercontent.com/u/1035011?v=4?s=100\" width=\"100px;\" alt=\"amjad\"/><br /><sub><b>amjad</b></sub></a><br /><a href=\"https://github.com/singularityhub/singularity-hpc/commits?author=Amjadhpc\" 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.31",
    "project_urls": {
        "Homepage": "https://github.com/singularityhub/singularity-hpc"
    },
    "split_keywords": [
        "singularity",
        " containers",
        " hpc",
        " lmd"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1d053a5d9e28dcacf5efb7f9c2da994518ff933aaef339bfab27d7adb68eb180",
                "md5": "561fa19171bc1216d9fda6111251fb59",
                "sha256": "871950b65cebe7dc9564f795c68b5f0f88e351a5cdaf9cf72447a00e71e57693"
            },
            "downloads": -1,
            "filename": "singularity_hpc-0.1.31-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "561fa19171bc1216d9fda6111251fb59",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 129681,
            "upload_time": "2025-01-11T21:02:21",
            "upload_time_iso_8601": "2025-01-11T21:02:21.052922Z",
            "url": "https://files.pythonhosted.org/packages/1d/05/3a5d9e28dcacf5efb7f9c2da994518ff933aaef339bfab27d7adb68eb180/singularity_hpc-0.1.31-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bb0cc9227f18531ae317ff125c014f4c2da02431ea9704fc82f4f61e782d1466",
                "md5": "f24cc5c22eaa9ab99e4c4bf935d13af0",
                "sha256": "12302c2c3504759a61e8d68fc9a1dcbd74577bc928b376e8c544003518a47826"
            },
            "downloads": -1,
            "filename": "singularity_hpc-0.1.31.tar.gz",
            "has_sig": false,
            "md5_digest": "f24cc5c22eaa9ab99e4c4bf935d13af0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 133267,
            "upload_time": "2025-01-11T21:02:24",
            "upload_time_iso_8601": "2025-01-11T21:02:24.128174Z",
            "url": "https://files.pythonhosted.org/packages/bb/0c/c9227f18531ae317ff125c014f4c2da02431ea9704fc82f4f61e782d1466/singularity_hpc-0.1.31.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-11 21:02:24",
    "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"
}
Vanessa Sochat
Elapsed time: 0.51040s