Skip to content

Commit

Permalink
docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed May 17, 2024
1 parent faa4dd5 commit 659a660
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 4 deletions.
2 changes: 2 additions & 0 deletions _sources/installing/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,7 @@ GTDB-Tk reference data
GTDB-Tk requires ~110G of external data that needs to be downloaded and unarchived:

For full package:
^^^^^^^^^^^^^^^^^

.. code-block:: bash
Expand All @@ -128,6 +129,7 @@ For full package:
tar xvzf gtdbtk_data.tar.gz
For split package:
^^^^^^^^^^^^^^^^^^

To create an archive from the GTDB-Tk release data parts:

Expand Down
14 changes: 11 additions & 3 deletions installing/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,11 @@
<li class="toctree-l2"><a class="reference internal" href="#hardware-requirements">Hardware requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="#python-libraries">Python libraries</a></li>
<li class="toctree-l2"><a class="reference internal" href="#third-party-software">Third-party software</a></li>
<li class="toctree-l2"><a class="reference internal" href="#gtdb-tk-reference-data">GTDB-Tk reference data</a></li>
<li class="toctree-l2"><a class="reference internal" href="#gtdb-tk-reference-data">GTDB-Tk reference data</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#for-full-package">For full package:</a></li>
<li class="toctree-l3"><a class="reference internal" href="#for-split-package">For split package:</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../faq.html">FAQ</a></li>
Expand Down Expand Up @@ -369,13 +373,16 @@ <h2>Python libraries<a class="headerlink" href="#python-libraries" title="Permal
<div class="section" id="gtdb-tk-reference-data">
<span id="installing-gtdbtk-reference-data"></span><h2>GTDB-Tk reference data<a class="headerlink" href="#gtdb-tk-reference-data" title="Permalink to this headline"></a></h2>
<p>GTDB-Tk requires ~110G of external data that needs to be downloaded and unarchived:</p>
<p>For full package:</p>
<div class="section" id="for-full-package">
<h3>For full package:<a class="headerlink" href="#for-full-package" title="Permalink to this headline"></a></h3>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>wget<span class="w"> </span>https://data.ace.uq.edu.au/public/gtdb/data/releases/latest/auxillary_files/gtdbtk_package/full_package/gtdbtk_data.tar.gz
wget<span class="w"> </span>https://data.gtdb.ecogenomic.org/releases/latest/auxillary_files/gtdbtk_package/full_package/gtdbtk_data.tar.gz<span class="w"> </span><span class="o">(</span><span class="w"> </span>mirror<span class="w"> </span><span class="k">for</span><span class="w"> </span>Australia<span class="o">)</span>
tar<span class="w"> </span>xvzf<span class="w"> </span>gtdbtk_data.tar.gz
</pre></div>
</div>
<p>For split package:</p>
</div>
<div class="section" id="for-split-package">
<h3>For split package:<a class="headerlink" href="#for-split-package" title="Permalink to this headline"></a></h3>
<p>To create an archive from the GTDB-Tk release data parts:</p>
<ol class="arabic simple">
<li><p>Ensure all parts of the GTDB-Tk release data are in the same directory.</p></li>
Expand Down Expand Up @@ -459,6 +466,7 @@ <h2>Python libraries<a class="headerlink" href="#python-libraries" title="Permal
</tbody>
</table>
</div>
</div>
</div>


Expand Down
Binary file modified objects.inv
Binary file not shown.
Binary file modified performance/performance-1.pdf
Binary file not shown.
Binary file modified performance/performance-2.pdf
Binary file not shown.
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit 659a660

Please sign in to comment.