https://github.com/fluorescence-tools/avtraj

https://github.com/fluorescence-tools/avtraj

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
  • .zenodo.json file
  • DOI references
    Found 8 DOI reference(s) in README
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.9%) to scientific vocabulary

Keywords

accessible-volumes avs fluorescence fps md-trajectory simulation
Last synced: 6 months ago · JSON representation

Repository

Basic Info
  • Host: GitHub
  • Owner: Fluorescence-Tools
  • License: lgpl-2.1
  • Language: Python
  • Default Branch: master
  • Homepage: https://avtraj.readthedocs.io
  • Size: 840 KB
Statistics
  • Stars: 1
  • Watchers: 1
  • Forks: 0
  • Open Issues: 2
  • Releases: 0
Topics
accessible-volumes avs fluorescence fps md-trajectory simulation
Created almost 8 years ago · Last pushed about 4 years ago
Metadata Files
Readme License

README.md

AvTraj

Build Status Anaconda-Server Badge Anaconda-Server Badge

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 latestdevelopments 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

The software depends on other libraries provided by conda-forge. Thus, as a first step, the conda-forge channel needs to be added.

commandline conda --add channels conda-forge

In a second step, the avtraj package can be installed.

commandline conda --add channels tpeulen conda install avtraj

Code Example

```python import mdtraj as md import avtraj as avt import json

# First load an MD trajectory by mdtraj
xtc_filename = './test/data/xtc/1am7_corrected.xtc'
topology_filename = './test/data/xtc/1am7_protein.pdb'
traj = md.load(
    xtc_filename,
    top=topology_filename
)
# Define your accessible volume (AV) parameters
av_parameters_donor = {
    'simulation_type': 'AV1',
    'linker_length': 20.0,
    'linker_width': 1.0,
    'radius1': 3.5,
    'simulation_grid_resolution': 1.0,
    'residue_seq_number': 57,
    'atom_name': 'CA'
}

# 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_donor = avt.AVTrajectory(
    traj,
    av_parameters=av_parameters_donor,
    name='57'
)
# These accessible volumes can be saved as xyz-file
av_traj_donor[0].save_av()

av_parameters_acceptor = {
    'simulation_type': 'AV1',
    'linker_length': 20.0,
    'linker_width': 1.0,
    'radius1': 3.5,
    'simulation_grid_resolution': 1.0,
    'residue_seq_number': 136,
    'atom_name': 'CA'
}

# The dye parameters can either be passed explicitly on creation of the object
av_traj_acceptor = avt.AVTrajectory(
    traj,
    av_parameters=av_parameters_acceptor,
    name='136'
)
av_traj_acceptor[0].save_av()


# 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".
# or by the tool `label_structure` provided by the software ChiSurf.
labeling_file = './test/data/labeling.fps.json'
av_dist = avt.AvDistanceTrajectory(
    traj,
    json.load(
        open(
            labeling_file
        )
    )
)
print(av_dist[:10])

```

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.

Owner

  • Name: Fluorescence Tools
  • Login: Fluorescence-Tools
  • Kind: organization

A hub for community driven open source fluorescence spectroscopy software

GitHub Events

Total
Last Year

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 23
  • Total Committers: 3
  • Avg Commits per committer: 7.667
  • Development Distribution Score (DDS): 0.435
Top Committers
Name Email Commits
tpeulen t****n@g****m 13
tpeulen _****2 9
Thomas Peulen t****n@h****e 1
Committer Domains (Top 20 + Academic)
hhu.de: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 7
  • Total pull requests: 3
  • Average time to close issues: 10 months
  • Average time to close pull requests: about 13 hours
  • Total issue authors: 4
  • Total pull request authors: 1
  • Average comments per issue: 3.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • samuelhaysom (3)
  • tpeulen (2)
  • gnw-gomes (1)
  • Jiaxing2018 (1)
Pull Request Authors
  • tpeulen (3)
Top Labels
Issue Labels
help wanted (2) bug (1) good first issue (1) enhancement (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 9 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 2
  • Total maintainers: 1
pypi.org: avtraj

A library to calculate FRET observables for MD trajectories by accessible volume (AV) simulations.In the AV simulations the sterically allowed conformation space of the labels is approximated the conformational space of flexible attached ellipsoids.

  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 9 Last month
Rankings
Dependent packages count: 10.0%
Dependent repos count: 21.7%
Average: 25.4%
Forks count: 29.8%
Stargazers count: 31.9%
Downloads: 33.6%
Maintainers (1)
Last synced: 6 months ago

Dependencies

environment.yaml conda
  • coverage
  • labellib
  • mdtraj
  • nose
  • numba
  • python 3.7.*
  • pyyaml
  • sphinx
  • sphinx_rtd_theme
requirements.txt pypi
  • LabelLib *
  • mdtraj *
  • numba *
  • numpy *