Skip to content

Commit

Permalink
docs: update RtD page
Browse files Browse the repository at this point in the history
  • Loading branch information
balajtimate committed Sep 19, 2024
1 parent 51957ac commit 21695ca
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
=================

Expand Down
40 changes: 40 additions & 0 deletions docs/guides/installation.rst
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 21695ca

Please sign in to comment.