Commit 36b489b9 authored by Lukas Jelonek's avatar Lukas Jelonek
Browse files

Start writing readme file

parent f5160486
......@@ -3,3 +3,43 @@
A tool that executes several bioinformatic tools for a set of protein
sequences. The results of all tools are converted into json documents, enabling
for simple post processing.
# Getting started (Setup)
Prerequisites:
* git
* python3
* nextflow
Supported bioinformatic tools:
* hmmer
* blastp
* signalp
* ghostx
Install nextflow:
~~~~
curl -fsSL get.nextflow.io | bash
~~~~
Checkout the repository:
~~~~
git clone git@git.computational.bio.uni-giessen.de:SOaAS/psot.git
~~~~
# Configuration
In the installation directory is a config.yaml file, that is used to override the paths to the
bioinformatic tools and that is used to specify the available profiles.
TODO write more about the structure of a profile
# How to create a new module?
TODO write what is a module
TODO write about module configuration
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment