-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
51957ac
commit 21695ca
Showing
2 changed files
with
55 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |