Skip to content

Commit

Permalink
Documentation updated
Browse files Browse the repository at this point in the history
  • Loading branch information
davidealbanese committed Jun 14, 2016
1 parent e411062 commit e007300
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 5 deletions.
5 changes: 3 additions & 2 deletions doc/source/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,16 @@ which all the software has already been installed, configured and tested.
docker pull compmetagen/micca
#. Run an instance of the image, mounting the host working directory
(``/Users/davide/micca``) on to the container working directory
(e.g. ``/Users/davide/micca``) on to the container working directory
``/micca``:

.. code-block:: sh
docker run -t -i -v /Users/davide/micca:/micca -w /micca compmetagen/micca /bin/bash
You need to write something like ``-v //c/Users/davide/micca:/micca`` if
you are in Windows.
you are in Windows or ``-v /home/davide/micca:/micca`` in Linux. The
``--rm`` option automatically removes the container when it exits.

#. Now you can use micca:

Expand Down
15 changes: 12 additions & 3 deletions docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,14 @@ classification and phylogenetic tree inference. The pipeline can be applied to a
range of highly conserved genes/spacers, such as 16S rRNA gene, Internal
Transcribed Spacer (ITS) and 28S rRNA. Homepage: http://www.micca.org.

The RDP Classifier is included.
The RDP classifier is preinstalled in the Docker image, so you can check the
software version by typing ``echo $RDPPATH``
(see https://hub.docker.com/r/compmetagen/rdpclassifier/).

## Available Tags/Versions

- latest: GitHub snapshot (master)
- 1.5.0: micca 1.5.0 (RDP Classifier release 2.11 included)
- 1.4.0: micca 1.4.0 (RDP Classifier release 2.11 included)
- 1.3.0: micca 1.3.0 (RDP Classifier release 2.11 included)
- 1.2.2: micca 1.2.2 (RDP Classifier release 2.11 included)
Expand All @@ -22,9 +25,15 @@ The RDP Classifier is included.

`docker pull compmetagen/micca`

2. Run an instance of the image, mounting the host directory:
2. Run an instance of the image, mounting the host working directory
(e.g. ``/Users/davide/micca``) on to the container working directory
``/micca``:

`docker run -t -i -v /Users/davide/micca:/micca -w /micca compmetagen/micca /bin/bash`
`docker run --rm -t -i -v /Users/davide/micca:/micca -w /micca compmetagen/micca /bin/bash`

You need to write something like ``-v //c/Users/davide/micca:/micca`` if
you are in Windows or ``-v /home/davide/micca:/micca`` in Linux. The
``--rm`` option automatically removes the container when it exits.

3. Run micca without parameters:

Expand Down

0 comments on commit e007300

Please sign in to comment.