github.com/tri-adam/singularity@v3.1.1+incompatible/README.md (about) 1 # Singularity 2 3 [![Build Status](https://travis-ci.org/sylabs/singularity.svg?branch=master)](https://travis-ci.org/sylabs/singularity) 4 [![CircleCI](https://circleci.com/gh/sylabs/singularity/tree/master.svg?style=svg)](https://circleci.com/gh/sylabs/singularity/tree/master) 5 [![Go Report Card](https://goreportcard.com/badge/github.com/sylabs/singularity)](https://goreportcard.com/report/github.com/sylabs/singularity) 6 7 - [Guidelines for Contributing](CONTRIBUTING.md) 8 - [Pull Request Template](.github/PULL_REQUEST_TEMPLATE.md) 9 - [Project License](LICENSE.md) 10 - [Documentation](https://www.sylabs.io/docs/) 11 - [Citation](http://journals.plos.org/plosone/article?id=10.1371/journal.pone.0177459) 12 13 Singularity is an open source container platform designed to be simple, fast, and secure. Singularity is optimized for [EPC](https://www.sylabs.io/2018/09/singularity-is-enterprise-performance-computing/) and HPC workloads, allowing untrusted users to run untrusted containers in a trusted way. 14 15 Check out [who is using Singularity](https://www.sylabs.io/singularity/whos-using-singularity/) and some [use cases of Singularity](https://www.sylabs.io/category/how-tos/) on our website. 16 17 ## Getting Started with Singularity 18 19 To install Singularity from source, see the [installation instructions](INSTALL.md). For other installation options, see [our website](https://www.sylabs.io/guides/3.0/user-guide/installation.html). 20 21 For system administrators, see the [administrator documentation](https://www.sylabs.io/guides/3.0/admin-guide/). 22 23 For users, see the [user documentation](https://www.sylabs.io/guides/3.0/user-guide/). 24 25 ## Contributing to Singularity 26 27 Community contributions are always greatly appreciated. To start developing Singularity, check out the [guidelines for contributing](CONTRIBUTING.md). 28 29 We also welcome contributions to our [user docs](https://github.com/sylabs/singularity-userdocs) and [admin docs](https://github.com/sylabs/singularity-admindocs). 30 31 ## Support 32 33 To get help with Singularity, check out the [Community Portal](https://www.sylabs.io/singularity/community/). 34 35 For additional support, [contact us](https://www.sylabs.io/contact/) to receive more information. 36 37 ## Cite as: 38 39 ``` 40 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 41 ``` 42 43 We also have a Zenodo citation: 44 45 ``` 46 Kurtzer, Gregory M.. (2016). Singularity 2.1.2 - Linux application and environment 47 containers for science. 10.5281/zenodo.60736 48 49 https://doi.org/10.5281/zenodo.60736 50 ``` 51 52 ## License 53 54 _Unless otherwise noted, this project is licensed under a 3-clause BSD license found in the [license file](LICENSE.md)._