Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/singularityware/singularity

Singularity has been renamed to Apptainer as part of us moving the project to the Linux Foundation. This repo has been persisted as a snapshot right before the changes.
https://github.com/singularityware/singularity

cloud-native container containers hpc linux parallel portability portable reproducible reproducible-science rootless-containers science singularity singularity-container

Last synced: 3 months ago
JSON representation

Singularity has been renamed to Apptainer as part of us moving the project to the Linux Foundation. This repo has been persisted as a snapshot right before the changes.

Awesome Lists containing this project

README 

        
# Singularity



IMPORTANT NOTE: Singularity has been renamed to

[Apptainer](https://apptainer.org/news/community-announcement-20211130).

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](https://github.com/apptainer/apptainer).

Any issue submitted here will be automatically closed.



[![CI](https://github.com/hpcng/singularity/actions/workflows/ci.yml/badge.svg)](https://github.com/hpcng/singularity/actions/workflows/ci.yml)



- [Documentation](https://singularity.hpcng.org/docs/)

- [Support](#support)

- [Community Meetings / Minutes / Roadmap](https://drive.google.com/drive/u/0/folders/1npfBhIDxqeJIUHZ0tMeuHPvc_iB4T2B6)

- [Project License](LICENSE.md)

- [Guidelines for Contributing](CONTRIBUTING.md)

- [Code of Conduct](CODE_OF_CONDUCT.md)

- [Citation](#citing-singularity)



## 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](LICENSE.md).



Check out [talks about Singularity](https://singularity.hpcng.org/talks)

and some [use cases of Singularity](https://singularity.hpcng.org/usecases)

on our website.



## Getting Started with Singularity



To install Singularity from source, see the [installation

instructions](INSTALL.md). For other installation options, see [our

guide](https://singularity.hpcng.org/admin-docs/master/installation.html).



System administrators can learn how to configure Singularity, and get an

overview of its architecture and security features in the [administrator

guide](https://singularity.hpcng.org/admin-docs/master/).



For users, see the [user guide](https://singularity.hpcng.org/user-docs/master/)

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](CONTRIBUTING.md).



Please note we have a [code of conduct](CODE_OF_CONDUCT.md). 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](https://singularity.hpcng.org/help).



We also welcome contributions to our [user

guide](https://github.com/hpcng/singularity-userdocs) and [admin

guide](https://github.com/hpcng/singularity-admindocs).



## Support



To get help with Singularity, check out the [Singularity

Help](https://singularity.hpcng.org/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](https://github.com/golang/go/wiki/Go-Release-Cycle#release-maintenance)

and [Security Policy](https://golang.org/security),

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

> 



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](https://doi.org/10.5281/zenodo.1310023).



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.

> 



## License



_Unless otherwise noted, this project is licensed under a 3-clause BSD license

found in the [license file](LICENSE.md)._