Doc: added documentation for dorado

eafit-apolo · Sep 29, 2023 · df5ad79 · df5ad79
1 parent 9355fd1
commit df5ad79
Show file tree

Hide file tree

Showing 3 changed files with 62 additions and 0 deletions.
diff --git a/docs/source/software/applications/dorado/0.3.4/index.rst b/docs/source/software/applications/dorado/0.3.4/index.rst
@@ -0,0 +1,51 @@
+.. _dorado-0.3.4:
+
+
+DORADO-0.3.4
+===========
+
+.. contents:: Table of Contents
+
+Basic information
+-----------------
+
+- **Install page:** https://github.com/nanoporetech/dorado/tree/master
+- **Installed on:** APOLO II
+
+Tested on (Requirements)
+------------------------
+
+- **OS base:** Rocky Linux 8.5 (x86_64) :math:`\boldsymbol{\ge}` 8
+
+- **Compiler** GCC 9.3.0
+
+Installation
+-------------
+
+#. First of all, we need to download the tar.gz file
+
+    .. code-block:: bash
+
+        $ wget wget https://cdn.oxfordnanoportal.com/software/analysis/dorado-0.3.4-linux-x64.tar.gz
+
+#. Then, we unpack this tar.gz file
+
+    .. code-block:: bash
+
+        $ tar xf dorado-0.3.4-linux-x64.tar.gz
+
+#. Then, we enter in the dorado directorie
+
+    .. code-block:: bash
+
+        $ cd dorado-0.3.4-linux-x64
+
+#. Now we are ready to use dorado.
+
+    .. code-block:: bash
+
+        $ ./bin/dorado
+
+:Author:
+
+- Juan Manuel Gómez <[email protected]>
diff --git a/docs/source/software/applications/dorado/index.rst b/docs/source/software/applications/dorado/index.rst
@@ -0,0 +1,10 @@
+.. _ dorado-index:
+
+DORADO
+=====
+
+.. toctree::
+   :caption: Versions
+   :maxdepth: 1
+
+   0.3.4/index
diff --git a/docs/source/software/applications/index.rst b/docs/source/software/applications/index.rst
@@ -92,3 +92,4 @@ and :ref:`Cronos <about_cronos>`) you can review the following entries:
    wrf/index
    Geant4/index
    ROOT/index
+   dorado/index