diff --git a/docs/index.rst b/docs/index.rst index 2a73807..4bb6a47 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -20,8 +20,11 @@ Workflow Availability --------------------- The workflow from GitHub uses all the listed Docker images to run all third-party tools. + The workflow is available on GitHub: `https://github.com/microbiomedata/metaAssembly` + The corresponding Docker images are available on DockerHub: + - `https://hub.docker.com/r/microbiomedata/spades` - `https://hub.docker.com/r/microbiomedata/bbtools` @@ -36,7 +39,7 @@ Requirements for Execution Hardware Requirements --------------------- -- Memory: >40 GB RAM +**Memory: >40 GB RAM** The memory requirement depends on the input complexity. Here is a simple estimation equation for the memory required based on kmers in the input file:: @@ -66,7 +69,8 @@ Sample dataset(s) - Small dataset: `Ecoli 10x (287M) `_ (Input/output included in tar.gz file) - Large dataset: `Zymobiomics mock-community DNA control (22G) `_ (Input/output included in tar.gz file) -- Long reads dataset: `PacBio `_ + +Long reads dataset: `PacBio `_ Zymobiomics mock-community DNA control (`SRR7877884 `_). The original dataset is ~4 GB. @@ -75,7 +79,7 @@ For testing, a 10% subsample of the dataset is used: (`SRR7877884-int-0.1.fastq. Input ----- -A JSON file containing the following information: +A `JSON file `_ containing the following information: 1. The path to the input FASTQ file (Illumina paired-end interleaved FASTQ or PacBio paired-end interleaved FASTQ) (recommended: output of the Reads QC workflow). 2. Project name: nmdc:XXXXXX