Repository files navigation

IMPORTANT NOTE: Singularity has been renamed toApptainer.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 tohttps://github.com/apptainer/apptainer.Any issue submitted here will be automatically closed.

• Documentation
• Support
• Community Meetings / Minutes / Roadmap
• Project License
• Guidelines for Contributing
• Code of Conduct
• Citation

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

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

Singularity is open source software, distributed under theBSD License.

Check outtalks about Singularityand someuse cases of Singularityon our website.

To install Singularity from source, see theinstallationinstructions. For other installation options, seeourguide.

System administrators can learn how to configure Singularity, and get anoverview of its architecture and security features in theadministratorguide.

For users, see theuser guidefor details on how to run and build containers with Singularity.

Community contributions are always greatly appreciated. To start developingSingularity, check out theguidelines for contributing.

Please note we have acode of conduct. Please follow it inall your interactions with the project members and users.

Our roadmap, other documents, and user/developer meeting information can befound in thesingularity community page.

We also welcome contributions to ouruserguide andadminguide.

To get help with Singularity, check out theSingularityHelp web page.

Singularity aims to maintain support for the two most recent stable versionsof Go. This corresponds to the GoRelease MaintenancePolicyandSecurity Policy,ensuring critical bug fixes and security patches are available for allsupported language versions.

The Singularity software may be cited using our Zenodo DOI10.5281/zenodo.1310023:

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

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

Please also consider citing the original publication describing Singularity:

Kurtzer GM, Sochat V, Bauer MW (2017) Singularity: Scientific containers formobility of compute. PLoS ONE 12(5): e0177459.https://doi.org/10.1371/journal.pone.0177459

Unless otherwise noted, this project is licensed under a 3-clause BSD licensefound in thelicense file.