Skip to content

Commit

Permalink
DOC How to run motus3 with NGLess
Browse files Browse the repository at this point in the history
  • Loading branch information
luispedro committed May 8, 2024
1 parent 0adfc34 commit 9570b0f
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/sources/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,7 @@ Authors
searchpath
reproducible
faq
motus3
nglesspy
cwl
advanced
Expand Down
57 changes: 57 additions & 0 deletions docs/sources/motus3.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# How to integrate mOTUs3 with NGLess

This document describes how to integrate mOTUs3 with NGLess. You will need to replace `/your/folder/` with the path to the folder where you want to install mOTUs3.

## Step 0. Install NGLess

Install NGLess following the instructions at [https://ngless.embl.de/install/](https://ngless.embl.de/install/) into a conda environment called `ngless`.

## Step 1. Install NGLess-contrib

```bash
conda activate ngless

git clone https://github.com/ngless-toolkit/ngless-contrib.git
cd ngless-contrib
```


change the directory in `install.sh` in line 7 to a folder in (`/your/folder/Modules/` in the example, it is **very important** that the last directory is `Modules`)

## Step 2. Install mOTUs3

Run

```bash
./install.sh
cd /your/folder/Modules/motus.ngm/3.1
```

Run

```bash`
python -m venv mOTUs-3.1.0-venv && \
source mOTUs-3.1.0-venv/bin/activate && \
wget https://github.com/motu-tool/mOTUs/archive/3.1.0.tar.gz && \
tar xf 3.1.0.tar.gz && \
rm -f 3.1.0.tar.gz && \
pip install ./mOTUs-3.1.0 && \
motus downloadDB && rm -rf mOTUs-3.1.0
```
## Step 3. Create an NGLess configuration file
Create an `ngless.conf` file with following lines (saved in `/your/folder/ngless.conf`):
```
user-directory = "/your/folder/"
user-data-directory = "/your/folder/"
temporary-directory= "/scratch/your_folder/temp/"
```
## Step 4. Run NGLess
Run `ngless` with the option `--config-file /your/folder/ngless.conf` (for debugging, run `ngless` with the option `--trace`).

0 comments on commit 9570b0f

Please sign in to comment.