Skip to content
Simple MLST pipeline.
Python HTML Shell
Branch: master
Clone or download
Isak Sylvin Isak Sylvin
Isak Sylvin and Isak Sylvin pubMLST lookup treat single letter as start of organism name. Fixes S…
…. pneumoniae
Latest commit 7276c4f Jul 31, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update pull_request_template.md Jun 26, 2019
artwork
microSALT
unique_references Integrated EXPAC genes to source code Jul 19, 2019
.gitignore
.gitlint.yml
.travis.yml
LICENSE Create LICENSE May 4, 2018
MANIFEST.in Integrated EXPAC genes to source code Jul 19, 2019
README.md Installation no longer requires cloning Jul 22, 2019
configExample.json
install.sh
requirements.txt Fixed quast installation errors Jul 19, 2019
setup.py

README.md

Build status Coverage Status

Microbial Sequence Analysis and Loci-based Typing pipeline

The microbial sequence analysis and loci-based typing pipeline (microSALT) is used to analyse microbial samples. It produces a quality control of the sample, determines a sample's organism specific sequence type, and its resistance pattern. microSALT also provides a database storage solution and report generation of these results.

microSALT uses a combination of python, sqLite and flask. Python is used for the majority of functionality, the database is handled through sqLite and the front-end is handled through flask. All analysis activity by microSALT requires a SLURM cluster.

Then continue with Configuration

Quick installation

  • bash <(curl https://raw.githubusercontent.com/Clinical-Genomics/microSALT/master/install.sh)
  • Perform all steps under section Configuration

Configuration

Copy the configuration file to microSALTs hidden home directory, or copy the configuration file anywhere and direct the envvar MICROSALT_CONFIG to it. See examples:

cp configExample.json $HOME/.microSALT/config.json

or

cp configExample.json /MY/FAV/FOLDER/config.json
export MICROSALT_CONFIG=/MY/FAV/FOLDER/config.json

Then edit the fields to match your environment.

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.
  • microSALT utils contains various functionality, including adding manually new reference organisms and re-generating reports.

Databases

MLST Definitions

microSALT will automatically download & use the MLST definitions for any organism on pubMLST (https://pubmlst.org/databases/). Other definitions may be used, as long as they retain the same format.

Resistance genes

microSALT will automatically download & use the resistance genes of resFinder (https://cge.cbs.dtu.dk/services/data.php). Any definitions will work, as long as they retain the same formatting.

Requirements

Hardware

  • A slurm enabled HPC
  • A (clarity) LIMS server

Software

Contributing to this repo

This repository follows the Github flow approach to adding updates. For more information, see https://guides.github.com/introduction/flow/

Credits

  • Isak Sylvin - Lead developer
  • Emma Sernstad - Accreditation ready reports
  • Tanja Normark - Contamination analysis, various issues
  • Maya Brandi - Various issues
You can’t perform that action at this time.