Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
SOaAS
psot.repository
Commits
37d1acf3
Commit
37d1acf3
authored
Jan 31, 2018
by
Lukas Jelonek
Browse files
Update readme
parent
278b28bc
Changes
2
Hide whitespace changes
Inline
Side-by-side
README.md
deleted
100644 → 0
View file @
278b28bc
# Protein Sequence Observation Tool
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
*
targetp
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
README.rst
0 → 100644
View file @
37d1acf3
Protein Sequence Observation Tool
=================================
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 for development (Setup)
Prerequisites:
* git
* python3
* nextflow
Supported bioinformatic tools:
* hmmer
* blastp
* signalp
* ghostx
* targetp
Install nextflow::
curl -fsSL get.nextflow.io | bash
Checkout the repository::
git clone git@git.computational.bio.uni-giessen.de:SOaAS/psot.git
Setup a virtualenv for development and install it in editable mode::
# install in development environment
virtualenv --python=python3 venv; source venv/bin/activate;
pip install -e .
# run tests
python3 setup.py test
# compile documentation
python3 setup.py build_sphinx
At the moment the required `dbxref` module is not available via a public pip
repository. You have to check it out via git and install it to the same virtual
environment.
Use the application::
psot analyze -f example/proteins.fas -o results -p fast
Run the tests::
# all tests
python3 setup.py test
# single tests module, e.g. test_repository
python3 setup.py test -s tests.test_repository
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment