diff --git a/README.md b/README.md index 199070d1..9c3aba17 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ [![Build status](https://github.com/clinical-genomics/microsalt/actions/workflows/run_tests.yml/badge.svg)](https://github.com/clinical-genomics/microsalt/actions/workflows/run_tests.yml) -[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4026043.svg)](https://doi.org/10.5281/zenodo.4026043) +[![DOI](https://img.shields.io/badge/DOI-10.5281%2Fzenodo.4026043-blue)](https://doi.org/10.5281/zenodo.4026043)

@@ -32,8 +32,8 @@ microSALT requires a SLURM cluster._ ### Manual install 1. Clone the repository and enter the directory -2. Checkout the desired branch -3. install package using `uv pip install .` +1. Checkout the desired branch +1. install package using `uv pip install .` ## Configuration @@ -48,13 +48,15 @@ Copy the configuration file anywhere and. microSALT uses [Singularity](https://sylabs.io/singularity/) containers to run the various tools used in the analysis. These containers are available on Clinical Genomics' DockerHub, and can be pulled using the following command: -`singularity pull docker://clinicalgenomics/microsalt-blast:latest` -`singularity pull docker://clinicalgenomics/microsalt-bwa:latest` -`singularity pull docker://clinicalgenomics/microsalt-picard:latest` -`singularity pull docker://clinicalgenomics/microsalt-quast:latest` -`singularity pull docker://clinicalgenomics/microsalt-samtools:latest` -`singularity pull docker://clinicalgenomics/microsalt-skesa:latest` -`singularity pull docker://clinicalgenomics/microsalt-trimmomatic:latest` +```Console +singularity pull docker://clinicalgenomics/microsalt-blast:latest +singularity pull docker://clinicalgenomics/microsalt-bwa:latest +singularity pull docker://clinicalgenomics/microsalt-picard:latest +singularity pull docker://clinicalgenomics/microsalt-quast:latest +singularity pull docker://clinicalgenomics/microsalt-samtools:latest +singularity pull docker://clinicalgenomics/microsalt-skesa:latest +singularity pull docker://clinicalgenomics/microsalt-trimmomatic:latest +``` > [!NOTE] > Remember to enter the correct path to the singularity images in the configuration file. @@ -62,12 +64,12 @@ microSALT uses [Singularity](https://sylabs.io/singularity/) containers to run t ## Usage - `microsalt analyse` contains functions to start sbatch job(s) & produce - output to `folders['results']`. Afterwards the parsed results are uploaded - to the SQL back-end and produce reports (HTML), which are then automatically - e-mailed to the user. + output to `folders['results']`. Afterwards the parsed results are uploaded + to the SQL back-end and produce reports (HTML), which are then automatically + e-mailed to the user. - `microsalt utils` contains various functionality, including generating the - sample description json, manually adding new reference organisms and - re-generating reports. + sample description JSON, manually adding new reference organisms and + re-generating reports. ## Setup diff --git a/artwork/microsalt.jpg b/artwork/microsalt.jpg new file mode 100644 index 00000000..0eb26877 Binary files /dev/null and b/artwork/microsalt.jpg differ diff --git a/artwork/swedac-old.jpg b/artwork/swedac-old.jpg new file mode 100644 index 00000000..8c59225c Binary files /dev/null and b/artwork/swedac-old.jpg differ diff --git a/artwork/swedac.jpg b/artwork/swedac.jpg new file mode 100644 index 00000000..674d6bbc Binary files /dev/null and b/artwork/swedac.jpg differ diff --git a/microSALT/__init__.py b/microSALT/__init__.py index df4ba3f9..e41f0863 100644 --- a/microSALT/__init__.py +++ b/microSALT/__init__.py @@ -1,6 +1,6 @@ import logging -__version__ = "5.0.0" +__version__ = "5.0.1" logger = None diff --git a/microSALT/server/templates/STtracker_page.html b/microSALT/server/templates/STtracker_page.html index 96cb59d2..40b3d952 100644 --- a/microSALT/server/templates/STtracker_page.html +++ b/microSALT/server/templates/STtracker_page.html @@ -6,8 +6,7 @@