Skip to content

Latest commit

 

History

History
108 lines (79 loc) · 4.58 KB

README.md

File metadata and controls

108 lines (79 loc) · 4.58 KB
Raw

Singularity

IMPORTANT NOTE: Singularity has been renamed to Apptainer. This repository is now for archiving the history in the release branches. The master branch is not in a consistent state. Submit all current issues and pull requests to https://github.com/apptainer/apptainer. Any issue submitted here will be automatically closed.

CI

What is Singularity?

Singularity is an open source container platform designed to be simple, fast, and secure. Many container platforms are available, but Singularity is designed for ease-of-use on shared systems and in high performance computing (HPC) environments. It features:

  • An immutable single-file container image format, supporting cryptographic signatures and encryption.
  • Integration over isolation by default. Easily make use of GPUs, high speed networks, parallel filesystems on a cluster or server.
  • Mobility of compute. The single file SIF container format is easy to transport and share.
  • A simple, effective security model. You are the same user inside a container as outside, and cannot gain additional privilege on the host system by default.

Singularity is open source software, distributed under the BSD License.

Check out talks about 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 guide.

System administrators can learn how to configure Singularity, and get an overview of its architecture and security features in the administrator guide.

For users, see the user guide for details on how to run and build containers with Singularity.

Contributing to Singularity

Community contributions are always greatly appreciated. To start developing Singularity, check out the guidelines for contributing.

Please note we have a code of conduct. Please follow it in all your interactions with the project members and users.

Our roadmap, other documents, and user/developer meeting information can be found in the singularity community page.

We also welcome contributions to our user guide and admin guide.

Support

To get help with Singularity, check out the Singularity Help web page.

Go Version Compatibility

Singularity aims to maintain support for the two most recent stable versions of Go. This corresponds to the Go Release Maintenance Policy and Security Policy, ensuring critical bug fixes and security patches are available for all supported language versions.

Citing Singularity

The Singularity software may be cited using our Zenodo DOI 10.5281/zenodo.1310023:

Singularity Developers (2021) Singularity. 10.5281/zenodo.1310023 https://doi.org/10.5281/zenodo.1310023

This is an 'all versions' DOI for referencing Singularity in a manner that is not version-specific. You may wish to reference the particular version of Singularity used in your work. Zenodo creates a unique DOI for each release, and these can be found in the 'Versions' sidebar on the Zenodo record page.

Please also consider citing the original publication describing Singularity:

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

License

Unless otherwise noted, this project is licensed under a 3-clause BSD license found in the license file.