README
¶
Singularity
Singularity is an open source container platform designed to be simple, fast, and secure. Singularity is optimized for EPC and HPC workloads, allowing untrusted users to run untrusted containers in a trusted way.
Check out who is using Singularity and some use cases of Singularity on our website.
Getting Started with Singularity
To install Singularity from source, see the installation instructions. For other installation options, see our website.
For system administrators, see the administrator documentation.
For users, see the user documentation.
Contributing to Singularity
Community contributions are always greatly appreciated. To start developing Singularity, check out the guidelines for contributing.
We also welcome contributions to our user docs and admin docs.
Support
To get help with Singularity, check out the Community Portal.
For additional support, contact us to receive more information.
Cite as:
Kurtzer GM, Sochat V, Bauer MW (2017) Singularity: Scientific containers for mobility of compute. PLoS ONE 12(5): e0177459. https://doi.org/10.1371/journal.pone.0177459
We also have a Zenodo citation:
Kurtzer, Gregory M.. (2016). Singularity 2.1.2 - Linux application and environment
containers for science. 10.5281/zenodo.60736
http://dx.doi.org/10.5281/zenodo.60736
License
Unless otherwise noted, this project is licensed under a 3-clause BSD license found in the license file.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
etc
|
|
|
internal
|
|
|
pkg/client/cache
Package cache provides support for automatic caching of any image supported by containers/image
|
Package cache provides support for automatic caching of any image supported by containers/image |
|
pkg/client/oci
Package oci provides transparent caching of oci-like refs
|
Package oci provides transparent caching of oci-like refs |
|
pkg/image
Package image provides underlying data types for Singularity image formats.
|
Package image provides underlying data types for Singularity image formats. |
|
pkg/libexec
Package libexec maintains a set of functions for acting on a configuration.
|
Package libexec maintains a set of functions for acting on a configuration. |
|
pkg/syecl
Package syecl implements the loading and management of the container execution control list feature.
|
Package syecl implements the loading and management of the container execution control list feature. |
|
pkg/sylog
Package sylog implements a basic logger for Singularity Go code to log messages in the same format as singularity_message() from C code
|
Package sylog implements a basic logger for Singularity Go code to log messages in the same format as singularity_message() from C code |
|
pkg
|
|
|
sypgp
Package sypgp implements the openpgp integration into the singularity project.
|
Package sypgp implements the openpgp integration into the singularity project. |
|
src
|
|
|
plugins/apps
Package apps [apps-plugin] provides the functions which are necessary for adding SCI-F apps support to Singularity 3.0.0.
|
Package apps [apps-plugin] provides the functions which are necessary for adding SCI-F apps support to Singularity 3.0.0. |