hub / github.com/apptainer/singularity

github.com/apptainer/singularity @v3.8.7 sqlite

repository ↗ · DeepWiki ↗ · release v3.8.7 ↗

2,397 symbols 11,553 edges 455 files 1,437 documented · 60%

README

Singularity

Singularity is an open source container platform designed to be simple, fast, and secure. Singularity is optimized for compute focused enterprise and HPC workloads, allowing untrusted users to run untrusted containers in a trusted way.

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 use and build Singularity containers.

Contributing to Singularity

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

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

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

We also have a Zenodo citation:

Kurtzer, Gregory M. et. al. Singularity - Linux application and environment
containers for science. 10.5281/zenodo.1310023

https://doi.org/10.5281/zenodo.1310023

This is an 'all versions' DOI. Follow the link to Zenodo to obtain a DOI specific to a particular version of Singularity.

License

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

Extension points exported contracts — how you extend this code

Operations (Interface)

Operations is an interface describing necessary operations to launch a container process. Some of them may be called wit [3 …

internal/pkg/runtime/engine/engine_linux.go

Driver (Interface)

Driver defines the image driver interface to register. [1 implementers]

pkg/image/driver.go

Bundle (Interface)

Bundle defines an OCI bundle interface to create/delete OCI bundles [1 implementers]

pkg/ocibundle/bundle.go

Callback (Interface)

Callback defines a plugin callback. Available callbacks are defined in pkg/plugin/callback.

pkg/plugin/plugin.go

HandleOpt (FuncType)

HandleOpt is a type representing option which can be passed to NewHandle.

pkg/sypgp/sypgp.go

EngineConfig (Interface)

EngineConfig is a generic interface to represent the implementations of an EngineConfig.

pkg/runtime/engine/config/config.go

EnvHandler (FuncType)

EnvHandler defines an environment handler type to set flag's values from environment variables

pkg/cmdline/env.go

SignOpt (FuncType)

SignOpt are used to configure s.

internal/app/singularity/sign.go

Core symbols most depended-on inside this repo

e2e/internal/e2e/singularitycmd.go

ExpectExit

called by 280

e2e/internal/e2e/singularitycmd.go

RunSingularity

called by 280

e2e/internal/e2e/singularitycmd.go

WithArgs

called by 279

e2e/internal/e2e/singularitycmd.go

WithCommand

called by 276

e2e/internal/e2e/singularitycmd.go

Shape

Function 1,188

Method 902

Struct 242

FuncType 29

TypeAlias 26

Interface 10

Languages

Go100%

Python1%

Modules by API surface

pkg/runtime/engine/singularity/config/config.go130 symbols

pkg/sypgp/sypgp.go58 symbols

internal/pkg/runtime/engine/singularity/container_linux.go46 symbols

internal/pkg/util/fs/mount/mount_linux.go41 symbols

internal/pkg/util/fs/layout/manager.go40 symbols

e2e/internal/e2e/singularitycmd.go31 symbols

internal/pkg/runtime/engine/config/starter/starter_linux.go30 symbols

internal/pkg/util/fs/helper.go28 symbols

internal/pkg/runtime/engine/singularity/rpc/args.go28 symbols

pkg/image/image.go26 symbols

internal/pkg/runtime/engine/config/oci/generate/generate.go24 symbols

internal/pkg/util/fs/helper_linux_test.go21 symbols

Dependencies from manifests, versioned

github.com/AdamKorcz/go-fuzz-headersv0.0.0-2021031916152 · 1×

github.com/Netflix/go-expectv0.0.0-2019072922592 · 1×

github.com/adigunhammedolalekan/registry-authv0.0.0-2020073012211 · 1×

github.com/alexflint/go-filemutexv0.0.0-2017102800423 · 1×

github.com/apex/logv1.9.0 · 1×

github.com/blang/semver/v4v4.0.0 · 1×

github.com/buger/jsonparserv1.1.1 · 1×

github.com/bugsnag/bugsnag-gov1.5.1 · 1×

github.com/bugsnag/panicwrapv1.2.0 · 1×

github.com/containerd/cgroupsv1.0.1 · 1×

github.com/containerd/containerdv1.5.8 · 1×

github.com/containernetworking/cniv0.8.1 · 1×

For agents

$ claude mcp add singularity \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact