Skip to content

Commit 9f81cd0

Browse files
authored
Update README.md
1 parent 4819a94 commit 9f81cd0

File tree

1 file changed

+16
-12
lines changed

1 file changed

+16
-12
lines changed

README.md

+16-12
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ See below for full instructions
1212

1313
# Accessing the webserver
1414

15-
The execution of the `start_slim_v0.3.sh` script deploys and start the webserver.
15+
The execution of the `start_slim_v0.4.sh` script deploys and start the webserver.
1616
By default, the webserver is accessible on the 8080 port.
1717

1818
* To access it on a remote server from your machine, type the server IP address followed by ":8080" (for example `156.241.0.12:8080`) from an internet browser (prefer Firefox and Google Chrome).
@@ -62,10 +62,10 @@ ACTACTYCAAATCGG
6262
**Example of sequences reference database file**
6363

6464
This FASTA file contains reference sequences with unique identifier and taxonomic path in the header.
65-
Such database can be downloaded for instance from [SILVA](https://www.arb-silva.de/) for both prokaryotes and eukaryotes (16S and 18S), [EUKREF](https://eukref.org/) for eularyotes (18S), [UNITE](https://unite.ut.ee/repository.php) for fungi (ITS), [MIDORI](http://www.reference-midori.info/download.php#) for metazoan (COI).
65+
Such database can be downloaded for instance from [SILVA](https://www.arb-silva.de/) for both prokaryotes and eukaryotes (16S and 18S), [EUKREF](https://eukref.org/) or [PR2](https://github.com/pr2database/pr2database) for eukaryotes (18S), [UNITE](https://unite.ut.ee/repository.php) for fungi (ITS), [MIDORI](http://www.reference-midori.info/download.php#) for metazoan (COI).
6666
Each header include a unique identifier (usually the accession),
6767
a space ' ', and the taxonomic path separated by a semi-colon (without any space, please use "_" underscore).
68-
**Prefer having the same amount of taxonomic rank for each reference sequences**
68+
**You should have the same amount of taxonomic rank for each reference sequences**
6969

7070
```
7171
>AB353770 Eukaryota;Alveolata;Dinophyta;Dinophyceae;Dinophyceae_X;Dinophyceae_XX;Peridiniopsis;Peridiniopsis_kevei
@@ -149,12 +149,12 @@ First of all, docker needs to be installed on the machine. You can find instruct
149149
* [docker for Ubuntu](https://docs.docker.com/install/linux/docker-ce/ubuntu/)
150150
* [docker for macOS](https://docs.docker.com/docker-for-mac/install/)
151151

152-
To install SLIM, get the last stable release [here](https://github.com/trtcrd/SLIM/archive/v0.3.tar.gz) or, using terminal :
152+
To install SLIM, get the last stable release [here](https://github.com/trtcrd/SLIM/archive/v0.4.tar.gz) or, using terminal :
153153
```bash
154154
sudo apt-get update && apt-get install git curl
155-
curl -OL https://github.com/trtcrd/SLIM/archive/v0.3.tar.gz
156-
tar -xzvf v0.3.tar.gz
157-
cd SLIM-0.3
155+
curl -OL https://github.com/trtcrd/SLIM/archive/v0.4.tar.gz
156+
tar -xzvf v0.4.tar.gz
157+
cd SLIM-0.4
158158
```
159159

160160
Before deploying SLIM, you need to configure the mailing account that will be used for mailing service.
@@ -174,13 +174,13 @@ exports.mailer = {
174174
```
175175

176176

177-
As soon as docker is installed and running, the SLIM archive downloaded and the mailing account set, it can be deployed by using the two scripts `get_dependencies_slim_v0.3.sh` and `start_slim_v0.3.sh` as **super user**.
178-
* `get_dependencies_slim_v0.3.sh` fetches all the bioinformatics tools needed from their respective repositories.
179-
* `start_slim_v0.3.sh` destroys the current running webserver to replace it with a new one. **/!\\** All the files previously uploaded and the results of analysis will be detroyed during the process.
177+
As soon as docker is installed and running, the SLIM archive downloaded and the mailing account set, it can be deployed by using the two scripts `get_dependencies_slim_v0.4.sh` and `start_slim_v0.4.sh` as **super user**.
178+
* `get_dependencies_slim_v0.4.sh` fetches all the bioinformatics tools needed from their respective repositories.
179+
* `start_slim_v0.4.sh` destroys the current running webserver to replace it with a new one. **/!\\** All the files previously uploaded and the results of analysis will be detroyed during the process.
180180

181181
```bash
182-
sudo bash get_dependencies_slim_v0.3.sh
183-
sudo bash start_slim_v0.3.sh
182+
sudo bash get_dependencies_slim_v0.4.sh
183+
sudo bash start_slim_v0.4.sh
184184
```
185185

186186
The server is configured to use up to 8 CPU cores per job. The amount of available cores will determine the amount of job that can be executed in parallel (1-8 -> 1 job, 16 -> 2 jobs, etc.). To admin and access SLIM logs, please refer to the docker command line [documentation](https://docs.docker.com/engine/reference/commandline/docker/).
@@ -217,6 +217,10 @@ Please refer to the wiki pages to learn [how to create a module](https://github.
217217

218218
# Version history
219219

220+
v0.4
221+
222+
Added timing checkpoints in the logs of the scheduler; Added the third-party software version infos in the email
223+
220224
v0.3
221225

222226
Fixed LULU module and the otu table writing is now done by a python script

0 commit comments

Comments
 (0)