Skip to content

Streamlit app for generating primers for PCR/Sanger sequencing based on genomic variants. Visit https://primertool.simonmichau.de/ for the deployed tool. Documentation available under https://simonmichau.github.io/primertool/

License

Notifications You must be signed in to change notification settings

simonmichau/primertool

Repository files navigation

Primertool

License: MIT Streamlit Python Docker

The premise of this package is to generate primers for PCR/Sanger sequencing for either:

  • a specific variant (hgvs variant nomenclature), either the whole exon or if not in an exon for the genomic position
  • an exon (transcript number and exon )
  • all exons of a transcript (transcript number)
  • around a genomic position (chromosome and start/stop position)

This tool allows for primers based in hg19 or hg38.


Table of Contents

Setup

Clone the repository

git clone https://github.com/simonmichau/primertool.git

and navigate to the cloned repository.

Docker Installation (Deployment)

Requires Docker installed.

  1. Build the Docker image

    docker build -t primertool .
  2. Run the Docker container

    docker run -p 8501:8501 primertool

Manual Installation (Development)

  1. Install requirements

    pip install requirements.txt
  2. Run the application

    streamlit run /path/to/primertool/streamlit_main.py

    The application will now be running on http://localhost:8501 and can be accessed through a web browser.

Documentation

The full documentation can be viewed here: Primertool Documentation

License

This project is licensed under the MIT License - see the LICENSE file for details.

About

Streamlit app for generating primers for PCR/Sanger sequencing based on genomic variants. Visit https://primertool.simonmichau.de/ for the deployed tool. Documentation available under https://simonmichau.github.io/primertool/

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published