From d0ee9f989c5c53e3e0298cfd181bfbcac02dc8a3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Guizard?= Date: Mon, 15 Feb 2021 10:39:41 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=96=20DOC:=20Complete=20README?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index cec9b13..d899f65 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,25 @@ # TAMA-singularity A definition file for building TAMA singularity container + +## Building container +``` +sudo singularity build TAMA.{sif, def} +``` + +## Using TAMA +There are two main Python scripts in TAMA: +* tama_collapse.py +* tama_merge.py + +They can be run as follows: + +### [tama_collapse.py](https://github.com/GenomeRIK/tama/wiki/Tama-Collapse) +``` +singularity exec TAMA.sif tama_collapse.py -h +``` + +### [tama_merge.py](https://github.com/GenomeRIK/tama/wiki/Tama-Merge) +``` +singularity exec TAMA.sif tama_merge.py -h +``` +