README.md

The Singularity Image Format (SIF)

This module contains an open source implementation of the Singularity Image Format (SIF) that makes it easy to create complete and encapsulated container environments stored in a single file.

Unless otherwise noted, the SIF source files are distributed under the BSD-style license found in the LICENSE.md file.

Download and Install From Source

To get the sif package to use directly from your programs:

go get -d github.com/sylabs/sif/v2

To get the siftool CLI program installed to $(go env GOPATH)/bin to manipulate SIF container files:

git clone https://github.com/sylabs/sif
cd sif
go run mage.go install

Go Version Compatibility

This module 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.

Contributing

SIF and SingularityCE are the work of many contributors. We appreciate your help!

To contribute, please read the contribution guidelines found in the CONTRIBUTING.md file.