Skip to main content

Build and deploy Documentation PyPI Code style: black DOI

FRETlabel is a PyMOL plugin to label nucleic acids with explicit fluorescent dyes. It aims to facilitate the workflow of setting up, running and evaluating molecular dynamics simulations with explicit organic fluorophores for in silico FRET calculations.

Specifically, FRETlabel includes the following features:

  • PyMOL plugin for fluorescent labeling: Label your nucleic acid of interest with the click of a button. The PyMOL plugin extends the AMBERDYES package (Graen et al. JCTC 2014) geometries and force field parameters of common nucleic acid linker chemistries.
  • Build new fragments interactively: Tutorials guide you step-by-step through the process of creating new base, linker and dye fragments by integrating with established pipelines for topology generation such as Antechamber and Acpype.
  • FRET prediction: Calculate FRET distributions from MD simulation with all-atom organic dyes. FRETlabel integrates with FRETraj to compute photon bursts based on distance RDA(t) and orientation trajectories κ2(t) of the fluorophores.

Fig. Schematic of FRETlabel: (i) A fluorescent dye (here Cy3) is coupled to a nucleic acid via a PyMOL plugin. (ii) An existing force field (e.g. AMBERDYES) is patched with parameters for linker fragments to enable MD simulations with explicit fluorophores (dots represent the spatial distribution of the dye).

Installation and Documentation

Follow the instructions for your platform here

FRETlabel and FRETraj

FRETlabel attaches explicit fluorophores on a custom nucleic acid. If you instead like to use an implicit, geometrical dye model that relies on accessible-contact volumes (ACV) then have a look our sister project FRETraj (Steffen, Bioinformatics, 2021)

References

If you use FRETlabel in your work please refer to the following paper:

  • F.D. Steffen, R.K.O. Sigel, R. Börner, Phys. Chem. Chem. Phys. 2016, 18, 29045-29055.

Additional readings

  • T. Graen, M. Hoefling, H. Grubmüller, J. Chem. Theory Comput. 2014, 10, 5505-5512.
  • B. Schepers, H. Gohlke, J. Chem. Phys. 2020, 152, 221103.
  • R. Shaw, T. Johnston-Wood, B. Ambrose, T. D. Craggs, and J. G. Hill, J. Chem. Theory Comput., 2020, 16, 7817–7824.
  • M. Zhao, F.D. Steffen R. Börner, M. Schaffer, R.K.O. Sigel, E. Freisinger, Nucleic Acids Res. 2018, 46, e13.
  • F.D. Steffen, R. Börner, E. Freisinger, R.K.O. Sigel, CHIMIA 2019, 73, 257-261.
  • F.D. Steffen, R.K.O. Sigel, R. Börner, Bioinformatics 2021, 37, 3953–3955.

1 PyMOL is a trademark of Schrödinger, LLC.

Metadata

Release files for fretlabel 0.2.1

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

Source distribution (sdist)

Source distribution for fretlabel 0.2.1
File Size Uploaded
fretlabel-0.2.1.tar.gz 32.5 kB Details

Built distribution (wheel)

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

Total release size: 63.2 kB

Release files / fretlabel-0.2.1.tar.gz

Download URL fretlabel-0.2.1.tar.gz
Size 32.5 kB
Tags Source
SHA-256 checksum
How to use checksums
e4152d11a2985f5408288a3a0d61735f049591c485ee030303316646585f93e8
BLAKE2b-256 checksum
How to use checksums
84faccbe813a84ef8f49e678f09a2a8634129756dd7847b0fb9ebf64cfad8689
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Mar 16, 2025.

Transparency log

Release files / fretlabel-0.2.1-py3-none-any.whl

Download URL fretlabel-0.2.1-py3-none-any.whl
Size 30.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5f074a4bc52082df79c91b45012e1c6e9f9df6bcd6b3c5924c4fb0dde4928909
BLAKE2b-256 checksum
How to use checksums
c7b5b18a0fbf858949f0698fa41cff1e6e6a85c8b849f22ec053004379add65e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Mar 16, 2025.

Transparency log

Release history Release notifications | RSS feed

This release

0.2.1 This release

2 release files

0.2.0

2 release files

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