/PrimerServer2

PrimerServer2: a high-throughput primer design and specificity-checking platform

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

PrimerServer2

PrimerServer2: a high-throughput primer design and specificity-checking platform

Description

PrimerServer was proposed to design genome-wide specific PCR primers. It uses candidate primers produced by Primer3, uses BLAST and nucleotide thermodynamics to search for possible amplicons and filters out specific primers for each site. By using multiple threads, it runs very fast, ~0.4s per site in our case study for more than 10000 sites.

This repository is based on Python3 and acts as the successor of legacy PrimerServer.

External Dependencies

Add these two softwares to your system PATH

Install

Via PIP (release only)

    pip3 install primerserver2

Via Github

    git clone https://github.com/billzt/PrimerServer2.git
    cd PrimerServer2
    python3 setup.py install

Run testing commands

    # (if installed from pip,) tests/query_design_multiple and tests/example.fa can be obtained from this github repository.

    # full mode: design primers and check specificity
    primertool full tests/query_design_multiple tests/example.fa -o full.json -t full.tsv

    # design mode: design primers only
    primertool design tests/query_design_multiple tests/example.fa -o design.json -t design.tsv

    # check mode: check specificity only
    primertool check tests/query_check_multiple tests/example.fa -o check.json -t check.tsv

Need to run the Web UI?

For test only

    git clone https://github.com/billzt/PrimerServer2.git
    cd PrimerServer2
    python3 -m venv venv # (it is recommended it run FLASK app in a virtual environment)
    . venv/bin/activate
    python3 setup.py develop
    flask run

For production deployment?

    I'll soon release a version