Skip to content

QuantumDNA is an open-source Python package for simulating DNA charge transfer and excited states using quantum methods, featuring a user-friendly GUI, and support for interdisciplinary research in physics, chemistry, biology, and medicine.

License

Notifications You must be signed in to change notification settings

dehe1011/QuantumDNA

Repository files navigation

License DOI Documentation Status Latest Release PyPI Version GitHub Workflow Status Code Style: black


Welcome to QuantumDNA

Author: Dennis Herb

This Python package can be cited as:

QuantumDNA (github.com/dehe1011/QuantumDNA), D. Herb, 2024, DOI: 10.5281/zenodo.12734027

Introduction

QuantumDNA is an open-source Python package for simulating charge transfer (CT) and excited states in DNA. These processes are key to understanding how DNA maintains genetic stability, how mutations occur, and even how we can use DNA in nanotechnology. QuantumDNA combines powerful quantum physics models like Linear Combination of Atomic Orbitals (LCAO) and tight-binding (TB) with quantum master equations to handle environmental effects. This makes it possible to analyze large DNA datasets quickly and accurately, uncovering insights into genetic and epigenetic phenomena. QuantumDNA comes with a clean and simple graphical user interface (GUI)—perfect for researchers and students, even without extensive coding experience.

Whether you're a scientist, student, or just curious, QuantumDNA is here to help you explore the fascinating world of DNA charge transfer. Dive in and start exploring today!

Key Features

  • Graphical User Interface (GUI): Intuitive and user-friendly interface, making the tool accessible to researchers and students with limited programming experience.
  • Parallelized Calculations: Optimized for performance, enabling the analysis of large DNA ensembles with efficient computational resource utilization.
  • Integration with Publicly Accessible Databases: Supports input geometries from widely used DNA structure databases.
  • Unified Framework: Provides a reproducible platform for simulating and comparing results from different scientific papers and methodologies.
  • Open-Source: Fully open-source and extensible, allowing users to modify and adapt the code to suit their specific research needs.
  • Cross-Disciplinary Usability: Designed for researchers across physics, chemistry, biology, and medicine to explore DNA charge dynamics collaboratively.

What's new

  • Added a graphical user interface (GUI) to the package which is based on the customtkinter package by Tom Schimansky.
  • 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 and alternative methods, 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. Do you know the reason for this observation?

from qDNA import calc_lifetime, calc_dipole

# input
upper_strand = 'GCG'
tb_model_name = 'ELM'
kwargs = dict(unit='rad/ps', relax_rate=3, source='Hawke2010')

# calculation
lifetime = calc_lifetime(upper_strand, tb_model_name, **kwargs)
dipole = calc_dipole(upper_strand, tb_model_name, **kwargs)

# output
print(f"Exciton lifetime {lifetime} fs")
print(f"Average charge separation {dipole} A")

Documentation

Documentation Status

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 graphical user interface (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 qDNA_app

app = qDNA_app()
app.mainloop()

The GUI allows you to easily explore and utilize the capabilities of the qDNA package. Below are some examples demonstrating its use:

  • 1BNA structure: Perform simulations with geometries from publically availbale databases (here: PDB geometry of the 1BNA sequence from RCSB.org).

Graphical User Interface (GUI).

Quantum-Physical 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 using Biovia Discovery Studio by removing the sugar-phosphate backbone. The subsequence selected for simulation is highlighted in blue.

(b) The GUI’s 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 tailored to the DNA geometry.

(c) To simulate the highlighted sequence from (a), set the upper strand to 02G_03C_04G and the lower strand to 23C_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: Create plots effortlessly by submitting your parameters through the GUI.

Plot obtained after pressing the submit button on the menu.

  • Calculation Display: Perform calculations, such as exciton lifetime and average charge separation, and view the results directly within the interface.

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.

Whether you're generating plots or calculating complex dynamics, the GUI provides a convenient and efficient way to achieve your goals.

Shortcuts

To enhance the readability and maintainability of the code, we have standardized a set of frequently used shortcuts. These abbreviations help keep the code concise while still being clear and understandable:

  • ham: hamiltonian
  • dm: density matrix
  • tb: tight-binding
  • eigv: eigenvalue/ eigenenergy
  • eigs: eigenstates/ eigenvectors
  • dim: dimension
  • fig: figure
  • op: operator
  • loc: local
  • glob: global
  • deph: dephasing
  • therm: thermalizing
  • seq: sequence
  • calc: calculate

References

Papers from our group:

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.

About

QuantumDNA is an open-source Python package for simulating DNA charge transfer and excited states using quantum methods, featuring a user-friendly GUI, and support for interdisciplinary research in physics, chemistry, biology, and medicine.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages