Skip to content

Commit b6f2451

Browse files
committed
trying adding README to docs folder
1 parent bb733db commit b6f2451

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

docs/README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
2+
3+
4+
# Singularity Python
5+
6+
[![Build Status](https://travis-ci.org/singularityware/singularity-python.svg?branch=master)](https://travis-ci.org/singularityware/singularity-python)
7+
8+
Singularity Python is a python module and command line tool for working with <a href="https://singularityware.github.io" target="_blank">Singularity</a> containers, specifically providing functions to visualize, package, and compare containers. Currently, most functions use Singularity on the command line, and some require sudo.
9+
10+
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. The following examples are provided:
11+
12+
13+
## Singularity Client
14+
- [basic usage](docs/cli/run_singularity/)
15+
16+
## Singularity Hub Client
17+
- [basic usage](docs/shub/client/)
18+
- [singularity hub paper analysis](docs/shub/paper/)
19+
20+
## Image Classification
21+
- [classify image](docs/classify/)
22+
23+
## Image Comparison
24+
25+
26+
## Reproducibility Metrics
27+
28+
29+
## Visualizations
30+
31+
- [Trees](docs/visualize/tree/)
32+
33+
34+
## Help and Contribution
35+
Please contribute to the package, or post feedback and questions as <a href="https://github.com/singularityware/singularity-python" target="_blank">issues</a>. For points that require discussion of the larger group, please use the <a href="https://groups.google.com/a/lbl.gov/forum/#!forum/singularity" target="_blank">Singularity List</a>
36+

0 commit comments

Comments
 (0)