QuantumDNA is an open-source Python package for simulating energy and charge transfer in DNA using quantum mechanical methods.
Project description
Welcome to QuantumDNA
This python package can be cited as:
Herb, D. et al. QuantumDNA: A python package for analyzing quantum charge dynamics in DNA and exploring its biological relevance. Computer Physics Communications 313, 109626 (2025). DOI: 10.1016/j.cpc.2025.109626
Introduction
The study of DNA charge dynamics is a highly interdisciplinary field and plays an important role in processes such as DNA damage detection, protein-DNA interactions, and DNA-based nanotechnology. However, despite significant progress in each of these areas, knowledge often remains inaccessible to researchers in other scientific communities. To bridge this gap, we have developed QuantumDNA: an open-source python package for simulating DNA charge transfer and excited state dynamics using quantum physical methods.
QuantumDNA uses a linear combination of atomic orbitals (LCAO) approach combined with tight-binding models and open quantum systems techniques. This way one can quickly scan large numbers DNA sequences, enabling statistical studies of genetic and epigenetic phenomena.
Whether you're a scientist, student, or just curious, QuantumDNA: dive in and start exploring!
Features
- Coarse-graining approach: linear combination of atomic orbitals (LCAO) and tight-binding models to efficiently simulate DNA charge dynamics.
- Parallelized Calculations: Enabling the analysis of large numbers of DNA seqeunces.
- Integration with publicly accessible databases: Users can input geometries from DNA structure databases as PDB files.
- GUI: Designed for researchers across physics, chemistry, biology, and medicine.
What's new
- Added a graphical user interface (GUI) to the package which is based on the customtkinter package.
- Added a Tutorial Jupyter Notebooks available on another GitHub repopsitory.
Getting started
Quick Installation
For a quick installation, you can install the qDNA package via pip:
pip install qDNA
To ensure compatibility and avoid conflicts with other packages, we recommend using a virtual environment. For detailed installation instructions, please refer to the Installation Guide.
Example Program
To test QuantumDNA, you can run the following simple example where the exciton lifetime and the average charge separation of a double-stranded GCG DNA sequence are calculated. You can try different sequences, tight-binding models, and keyword arguments to investigate how these factors affect the exciton lifetime and average charge separation. For example, you might find that in general more uniform sequences show higher values.
from qDNA import calc_lifetime, calc_dipole
# input
tb_sites = get_tb_sites('GCG')
kwargs = dict(tb_model_name = 'ELM', unit='rad/ps', relax_rate=3, source='Hawke2010')
# calculation
eva = Evaluation(tb_sites, **kwargs)
lifetime = eva.calc_lifetime()
charge_separation = eva.calc_charge_separation()
# output
print(f"Exciton lifetime {lifetime} fs")
print(f"Average charge separation {charge_separation} A")
Documentation
The documentation webpage for the latest release is available for reading on Read The Docs. Tutorials can be found in a separate GitHub repository QuantumDNA-notebooks.
Graphical User Interface
The qDNA package includes a GUI that provides an intuitive and user-friendly way to interact with the package's functionalities. You can access the GUI with the following code:
from qDNA.gui import QDNApp
QDNApp().run()
The GUI allows you to easily explore and utilize the capabilities of the qDNA package. Below are some examples demonstrating its use:
- Usage example: Perform simulations with geometries from publically availbale databases (here: PDB geometry of the 1BNA sequence from RCSB.org).
Simulations with Real Geometries via the GUI(a) A Protein Data Bank (PDB) file containing the DNA geometry was obtained from RCSB.org (identifier:
1BNA) and modified usingBiovia Discovery Studio. The subsequence selected for simulation is highlighted in blue.(b) The PDB Input Window allows users to upload the modified PDB file, specify an identifier, and select a Tight-Binding (TB) model. Clicking the "Save" button computes TB parameters.
(c) To simulate the highlighted sequence from (a), set the upper strand to
02G_03C_04Gand the lower strand to23C_22G_21C. Ensure the identifier (e.g.,1BNA) is selected as the source. Exciton calculations can be performed using the Evaluation tab, with results displayed in the console at the bottom right (highlighted in green).(d) The plotting window provides a heatmap visualization of time-evolved populations for the DNA sequence highlighted in (a). All simulation steps can also be performed programmatically without the GUI, such as using Jupyter Notebooks.
- Plot Generation: Plot obtained after pressing the submit button on the menu.
- Calculation Display: Screenshot of the menu of the user interface with calculations of the exciton lifetime, average charge separation and dipole moment displayed in the frame on the bottom right.
Shortcuts
To enhance the readability of the code, we have frequently used the following shortcuts:
ham: hamiltoniandm: density matrixtb: tight-bindingeigv: eigenvalue/ eigenenergyeigs: eigenstates/ eigenvectorsdim: dimensionfig: figureop: operatorloc: localglob: globaldeph: dephasingtherm: thermalizingseq: sequencecalc: calculate
References
Papers from our group:
- R. Siebert, O. Ammerpohl, M. Rossini et al. A quantum physics layer of epigenetics: a hypothesis deduced from charge transfer and chirality-induced spin selectivity of DNA. Clin Epigenet 15, 145 (2023).
- D. Herb, M. Rossini and J. Ankerhold, Ultrafast excitonic dynamics in DNA: Bridging correlated quantum dynamics and sequence dependence. Physical Review E 109, 064413 (2024).
Tight-binding parameters:
Tight-binding models:
DNA excited states and excitons:
DNA charge transfer:
Simulation of open quantum systems:
Support
For support, please contact the author at dennis.herb@uni-ulm.de.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file qdna-1.0.0.tar.gz.
File metadata
- Download URL: qdna-1.0.0.tar.gz
- Upload date:
- Size: 4.7 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3faef59f7c303c77fc5ed9995321fc676c6e97cfb5a0f0d28d610b159d404f64
|
|
| MD5 |
e47a63e921bfcca8fc662ba36846124f
|
|
| BLAKE2b-256 |
5772b9b656470de17d0756abed01b037c5706d13e27a896b5b3d120fe69999be
|
File details
Details for the file qdna-1.0.0-py3-none-any.whl.
File metadata
- Download URL: qdna-1.0.0-py3-none-any.whl
- Upload date:
- Size: 3.5 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e53c88528979fe75cdaf71c5d789b7160dd78938ce91ad275c1730e605d23f38
|
|
| MD5 |
16300ef7ec9b0c322b53512606f9a22d
|
|
| BLAKE2b-256 |
f83e624b43ae1c0fdcc1f752ace12c809a638a0c247d8670dcd54bdcbf15109d
|