Skip to content

Commit

Permalink
update installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
drewjbeh committed Jul 25, 2023
1 parent 3ed996d commit eeb3923
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Detailed methodology is shown in the image below, and described in Behrens et al

Please see the full documentation for explanations of dependencies, inputs formatting, and outputs.

To use mim-tRNAseq, it is recommended to install the package using `conda`, preferably in its own environment. Significant time improvements can be made to installing mimseq using mamba which we will use within the mimseq environment:
To use mim-tRNAseq, it is recommended to install the package using `conda`, preferably in its own environment. Significant time and dependency-related improvements can be made to using conda for managing environment and installing mimseq using the [Mambaforge](https://github.com/conda-forge/miniforge) version of conda Miniforge. We recommend installing Mambaforge and then followin the steps below:
```bash
conda create -n mimseq python=3.7
conda activate mimseq
Expand Down
3 changes: 2 additions & 1 deletion docs/source/start.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Quick-start guide
Installation
^^^^^^^^^^^^

To use mim-tRNAseq, it is recommended to install the package using `conda`, preferably in its own environment. Significant time improvements can be made to installing mimseq using mamba which we will use within the mimseq environment:
To use mim-tRNAseq, it is recommended to install the package using `conda`, preferably in its own environment. Significant time and dependency-related improvements can be made to using conda for managing environment and installing mimseq using the Mambaforge_ version of conda Miniforge. We recommend installing Mambaforge and then followin the steps below:
::
conda create -n mimseq python=3.7
conda activate mimseq
Expand All @@ -31,6 +31,7 @@ Alternatively, mim-tRNAseq can be installed with `pip`, in which case all additi
The source code is also available on GitHub_

.. _GitHub: https://github.com/nedialkova-lab/mim-tRNAseq
.. _Mambaforge: https://github.com/conda-forge/miniforge

Once installed, mim-tRNAseq should be executable and help displayed, by running
::
Expand Down

0 comments on commit eeb3923

Please sign in to comment.