Installation

Installation (current)

pip install singularity

Installation (dev)

pip install git+git://github.com/singularityware/singularity-python.git

Quick Start

Installation will place an executable, shub in your bin folder.

Test your installation

After installation, you should be able to run shub on the command line, without any input args, to see if you have Singularity installed (and test the package):

$ shub
	Please specify one or more containers with --image(s)


      $  shub --help
	usage: shub [-h] [--image IMAGE] [--images IMAGES] [--debug]
		    [--outfolder OUTFOLDER] [--package] [--os] [--oscalc] [--tags]
		    [--tree] [--simtree] [--subtract] [--simcalc] [--size SIZE]

	Singularity Hub command line tool

	optional arguments:
	  -h, --help            show this help message and exit
	  --image IMAGE         full path to singularity image (for use with --package
		                and --tree)
	  --images IMAGES       images, separated by commas (for use with --simtree
		                and --subtract
	  --debug               use verbose logging to debug.
	  --outfolder OUTFOLDER
		                full path to folder for output, stays in tmp (or pwd)
		                if not specified
	  --package             package a singularity container for singularity hub
	  --os                  estimate the operating system of your container.
	  --oscalc              calculate similarity score for your container vs.
		                docker library OS.
          --osplot              plot similarity scores for your container vs. docker
                                library OS.
	  --tags                retrieve list of software tags for an image, itself
		                minus it's base
	  --tree                view the guts of an singularity image (use --image)
	  --simtree             view common guts between two images (use --images)
	  --subtract            subtract one container image from the second to make a
		                difference tree (use --images first,subtract)
	  --simcalc             calculate similarity (number) between images based on
		                file contents.
	  --size SIZE           If using Docker or shub image, you can change size
		                (default is 1024)