Skip to main content

HomologyViz

PyPI Version GitHub License Python Built with Dash + Plotly


🧬 Create visual representations of BLASTn alignments

HomologyViz is a Python-based web app for visualizing pairwise BLASTn alignments between DNA sequences with gene annotations and customizable color maps. It allows you to explore homologous regions and gene structures interactively, with publication-ready output.

HomologyViz reads GenBank files (.gb), uses the CDS features to plot genes as arrows, and performs local BLASTn alignments between sequences. Homology regions are colored by identity percentage using a flexible, user-selectable color scale.

You may optionally customize gene colors directly in the GenBank file by adding a /Color tag to a CDS feature. For example, /Color="#00ff00" will render that gene in green. You can also edit gene colors interactively using the web interface.

HomologyViz is ideal for researchers and students with little or no coding experience. It runs locally and requires no cloud deployment or server hosting.


🚀 Features

  • Interactive plots of aligned DNA sequences
  • Gene annotations rendered as directional arrows
  • Homology regions colored by % identity using customizable color scales
  • Click-to-select genes or regions and change their color
  • Exportable visualizations (SVG, PNG, PDF, HTML)
  • Built with Dash and Plotly

🖼 Example

HomologyViz


✅ Requirements

  • Python 3.11, 3.12
  • blastn (part of BLAST+) must be installed and available in your system PATH if installing via pip or git clone.

HomologyViz has been tested in Google Chrome on macOS, but should work across all modern browsers and platforms.


📦 Installation

  • Using pip:
python3.12 -m pip install homologyviz
  • Cloning this repository:
git clone https://github.com/yourusername/homologyviz.git
cd homologyviz
python3.12 pip install .
  • Using conda:
conda create -n homologyviz python=3.12 pip
conda activate homologyviz
pip install homologyviz

🧪 Usage

Once installed, launch the app by typing:

homologyviz

📚 Documentation

You can find the full documentation for HomologyViz at:

👉 https://homologyviz.readthedocs.io


👤 Author

Created by Iván Muñoz Gutiérrez, PhD
Montana State University
Department of Microbiology & Cell Biology
Github: @ivanmugu


🙏 Acknowledgments


📄 License

BSD 3-Clause License


📝 Notes

  • I am developing HomologyViz in my free time, so if you find a bug, it may take me some time to fix it. However, I will fix the problems as soon as possible.
  • If you have any suggestions, let me know, and I will try to implement them.

Metadata

Release files for homologyviz 0.1.59

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for homologyviz 0.1.59
File Size Uploaded
homologyviz-0.1.59.tar.gz 486.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for homologyviz 0.1.59
File Interpreter ABI Platform
homologyviz-0.1.59-py3-none-any.whl Python 3 none any Details

Total release size: 923.4 kB

Release files / homologyviz-0.1.59.tar.gz

Download URL homologyviz-0.1.59.tar.gz
Size 486.6 kB
Tags Source
SHA-256 checksum
How to use checksums
8ef9c2c45b8ef14ad6bac44daf8b33be264ba5be7fcd9f03cc6739b565c02580
BLAKE2b-256 checksum
How to use checksums
c41ceca118af5c182a72d6b0003dad3ce003262c58355a7030edd9c49805878d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.14

Release files / homologyviz-0.1.59-py3-none-any.whl

Download URL homologyviz-0.1.59-py3-none-any.whl
Size 436.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d6947bc3e957f27a882d1d0b1ebbc6734aa01f8ebc19d83a3790b73bf0d2e0a0
BLAKE2b-256 checksum
How to use checksums
8363f127514a59234d4daaacfda61064186078ff9583ecc5203df8f72364818a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.14

Release history Release notifications | RSS feed

This release

0.1.59 This release

2 release files

0.1.54

2 release files

0.1.53

2 release files

0.1.51

2 release files

0.1.33

2 release files

0.0.21

2 release files

0.0.20

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page