Home

Singularity Python is a python module and command line tool for working with Singularity containers, specifically providing functions to visualize, package, and compare containers. Currently, most functions use Singularity on the command line, and some require sudo.

The Singularity-Python code is licensed under the MIT open source license, which is a highly permissive license that places few limits upon reuse. This ensures that the code will be usable by the greatest number of researchers, in both academia and industry. These docs are under development, and so far we have the following provided examples:

• Getting Started
  • Installation
• Singularity Client
  • General Usage
  • Command Line Usage
    • shub.create
• Singularity Registry Client
• Singularity Hub Client
  • General Usage
  • Paper Analysis
• Container Analysis
  • Image Classification
  • Reproducibility
• Visualization
  • Container Trees

Help and Contribution

Please contribute to the package, or post feedback and questions as issues. For points that require discussion of the larger group, please use the Singularity List