Skip to main content

AvTraj

AvTraj is tool to calculate FRET observables from MD-trajectories. Read, write and analyze accessible volumes (AVs) using MD trajectories as an input with only a few lines of Python code. By the use of LabelLib AvTraj provides programmatic access to latest developments in implicit dye models for FRET experiments DOI for Citing COSB.

AvTraj is a python library that allows users to perform simulations of accessible volumes for molecular dynamics (MD) trajectories. AvTraj serves as a high-level interface for the development of new methodologies for structure-based fluorescence spectroscopy.

Features include:

    A wide support of diverse MD formats by the use of MDTraj. Extremely fast calculation of AVs by the
    use of LabelLib (e.g. xxxx the speed of yyyy). Extensive analysis functions including those that compute
    inter-dye distances, FRET-efficiencies, fluorescence decays, distance distributions, and an Pythonic API.

AVTraj includes a command-line application, avana, for screening and analyzing structural models.

Relation of other software and libraries

LabelLib serves as core low-level library for the software Olga and the higher-level Python library AvTraj. The deprecated software FPS is independent of LabelLib.

LabelLib and other software/libraries

Olga is a software dedicated towards experimentalists. Olga provides a graphical user interface for the calculation of accessible volumes (AVs), screen a set of structural models against experimental observables, rigid-body docking, and the optimal design of new FRET experiments.

AvTraj AvTraj is a Python library for the calculation of accessible volumes (AVs), screening. AvTraj facilitates the development of new analytical approaches for FRET-based structural models. Avtraj facilitates processing of MD-simulations and the development of Python scripts handling FRET-based structural models.

FPS is a software with a graphical user interface for the FRET-based structural modeling. FPS can calculate accessible volumes (AVs), screen a set of structural models against experimental observables, and can generate new structural models by rigid-body docking using experimental FRET data.

Installation

Anaconda

conda --add channels tpeulen
conda install avtraj

Code Example

import mdtraj as md
import avtraj as avt

# First load an MD trajectory by mdtraj
traj = md.load('./examples/hGBP1_out_3.h5')

# Pass a trajectory to fps.AVTrajectory. This creates an object, which can be 
# accessed as a list. The objects within the "list" are accessible volumes  
av_traj = avt.AVTrajectory(traj, '18D', attachment_atom_selection='resSeq 7 and name CB')
# These accessible volumes can be saved as xyz-file
av_traj[0].save_xyz('test_344.xyz')

# The dye parameters can either be passed explicitly on creation of the object
av_traj = avt.AVTrajectory(traj, '18D', attachment_atom_selection='resSeq 7 and name CB', linker_length=25., linker_width=1.5, radius_1=6.0)

# or they can be selected from a predefined set of parameters found in the JSON file dye_definition.json located within
# the package directory 
av_traj = avt.AVTrajectory(traj, '18D', attachment_atom_selection='resSeq 7 and name CB', dye_parameter_set='D3Alexa488')

# To calculate a trajectory of distances and distance distributions first a labeling file and a "distance file" 
# needs to be specified. The distance file contains a set of labeling positions and distances and should be compatible
# to the labeling files used by the software "Olga". By default the 
av_dist = avt.AvDistanceTrajectory(traj, './examples/hGBP1_distance.json')

Citations

  • MDTraj - DOI for Citing MDTraj
  • FPS - DOI for Citing FPS

License

GNU LGPL version 2.1, or at your option a later version of the license. Various sub-portions of this library may be independently distributed under different licenses. See those files for their specific terms.

Metadata

Release files for avtraj 0.0.8

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

Source distribution (sdist)

Source distribution for avtraj 0.0.8
File Size Uploaded Provenance
avtraj-0.0.8.tar.gz 66.1 kB Without provenance Details

Release files / avtraj-0.0.8.tar.gz

Download URL avtraj-0.0.8.tar.gz
Size 66.1 kB
Tags Source
SHA-256 checksum
How to use checksums
120bca8af49644632e35c3d97e0363c6b24f21b54d983a5f5317697300332e44
BLAKE2b-256 checksum
How to use checksums
7ca31c4f51356b02efdfd1cab73e310f86e4e704cc31801991a6625bd6e7d751
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/2.7.15

Security for avtraj 0.0.8

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.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.8 This release

1 release file No provenance

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