diff --git a/docs/api/index.rst b/docs/api/index.rst index 42e2e565..24ae531b 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -3,6 +3,21 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. +Welcome to HTSinfer Documentation! +================================== + +HTSinfer is a tool for high-throughput sequencing inference. + +This documentation will guide you through installation, usage, and the API reference. + +HTSinfer Documentation +======================= + +.. toctree:: + :caption: Contents: + + guides/installation + HTSinfer API docs ================= diff --git a/docs/guides/installation.rst b/docs/guides/installation.rst new file mode 100644 index 00000000..63ca4e79 --- /dev/null +++ b/docs/guides/installation.rst @@ -0,0 +1,40 @@ +Installation Guide +================== + +This section describes how to install HTSinfer using Conda. + +Clone the Repository and Install Dependencies +--------------------------------------------- + +To install HTSinfer, first clone the repository and install the dependencies via `Conda`: + +.. code-block:: bash + + git clone https://github.com/zavolanlab/htsinfer + cd htsinfer + conda env create --file environment.yml + # Alternatively, to install with development dependencies, + # run the following instead + conda env create --file environment-dev.yml + +.. note:: + + Creating the environment may take some time. It is strongly recommended to install `Mamba`_ and replace ``conda`` with ``mamba`` in the previous commands for faster installation. + +Activate the Conda Environment +------------------------------ + +After the installation is complete, activate the `htsinfer` Conda environment with: + +.. code-block:: bash + + conda activate htsinfer + +Verify the Installation (Optional) +---------------------------------- + +If you have installed the development or testing dependencies, you can verify that HTSinfer was installed correctly by executing the tests shipped with the package: + +.. code-block:: bash + + python -m pytest