<img src="https://raw.githubusercontent.com/fdsteffen/fretraj/master/docs/images/fretraj_logo_readme.png">
[![Build Status](https://github.com/fdsteffen/fretraj/workflows/FRETraj%20test/badge.svg)](https://github.com/fdsteffen/fretraj/actions)
[![Docs Status](https://github.com/fdsteffen/fretraj/workflows/FRETraj%20docs/badge.svg)](https://github.com/fdsteffen/fretraj/actions)
[![PyPI](https://img.shields.io/pypi/v/fretraj)](https://pypi.org/project/fretraj/)
[![Conda Version](https://img.shields.io/conda/vn/conda-forge/fretraj.svg)](https://anaconda.org/conda-forge/fretraj)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
*FRETraj* is a Python module for **predicting FRET efficiencies** by calculating multiple accessible-contact volumes (multi-ACV) to estimate donor and acceptor dye dynamics. The package features a user-friendly **PyMOL plugin**<sup>[1](#pymol)</sup> for for FRET-assisted, integrative structural modeling. It interfaces with the [*LabelLib*](https://github.com/Fluorescence-Tools/LabelLib) library for fast computation of ACVs.
Specifically, *FRETraj* is designed to:
- plan (single-molecule) FRET experiments by optimizing **labeling positions**
- interpret FRET-based **distance measurements** on a biomolecule
- integrate FRET experiments with **molecular dynamics** simulations
<img src="https://raw.githubusercontent.com/fdsteffen/fretraj/master/docs/images/graphical_abstract.png">
## Installation and Documentation
Follow the instructions for your platform [here](https://rna-fretools.github.io/fretraj/getting_started/installation)
## References
If you use **FRETraj** in your work please refer to the following paper:
- F.D. Steffen, R.K.O. Sigel, R. Börner, *Bioinformatics* **2021**. [![](https://img.shields.io/badge/DOI-10.1093/bioinformatics/btab615-blue.svg)](https://doi.org/10.1093/bioinformatics/btab615)
### Additional readings
- F.D. Steffen, R.K.O. Sigel, R. Börner, *Phys. Chem. Chem. Phys.* **2016**, *18*, 29045-29055.
- S. Kalinin, T. Peulen, C.A.M. Seidel et al. *Nat. Methods*, **2012**, *9*, 1218-1225.
- T. Eilert, M. Beckers, F. Drechsler, J. Michaelis, *Comput. Phys. Commun.*, **2017**, *219*, 377–389.
- M. Dimura, T. Peulen, C.A.M. Seidel et al. *Curr. Opin. Struct. Biol.* **2016**, *40*, 163-185.
- M. Dimura, T. Peulen, C.A.M Seidel et al. *Nat. Commun.* **2020**, *11*, 5394.
---
<sup><a name="pymol">1</a></sup> PyMOL was developed by WarrenDeLano and is maintained by Schrödinger, LLC.
Raw data
{
"_id": null,
"home_page": "https://rna-fretools.github.io/",
"name": "fretraj",
"maintainer": "Fabio Steffen",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "fabio.steffen@chem.uzh.ch",
"keywords": "FRET,single-molecule,molecular dynamics,PDB,structure prediction",
"author": "Fabio Steffen",
"author_email": "fabio.steffen@chem.uzh.ch",
"download_url": "https://files.pythonhosted.org/packages/e4/73/399af89bf5e8c8c039b437ee1f8999c4918b1e604d0da4d0e56325f908c6/fretraj-0.2.10.tar.gz",
"platform": null,
"description": "<img src=\"https://raw.githubusercontent.com/fdsteffen/fretraj/master/docs/images/fretraj_logo_readme.png\">\n\n[![Build Status](https://github.com/fdsteffen/fretraj/workflows/FRETraj%20test/badge.svg)](https://github.com/fdsteffen/fretraj/actions)\n[![Docs Status](https://github.com/fdsteffen/fretraj/workflows/FRETraj%20docs/badge.svg)](https://github.com/fdsteffen/fretraj/actions)\n[![PyPI](https://img.shields.io/pypi/v/fretraj)](https://pypi.org/project/fretraj/)\n[![Conda Version](https://img.shields.io/conda/vn/conda-forge/fretraj.svg)](https://anaconda.org/conda-forge/fretraj)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n\n*FRETraj* is a Python module for **predicting FRET efficiencies** by calculating multiple accessible-contact volumes (multi-ACV) to estimate donor and acceptor dye dynamics. The package features a user-friendly **PyMOL plugin**<sup>[1](#pymol)</sup> for for FRET-assisted, integrative structural modeling. It interfaces with the [*LabelLib*](https://github.com/Fluorescence-Tools/LabelLib) library for fast computation of ACVs. \nSpecifically, *FRETraj* is designed to:\n- plan (single-molecule) FRET experiments by optimizing **labeling positions**\n- interpret FRET-based **distance measurements** on a biomolecule\n- integrate FRET experiments with **molecular dynamics** simulations\n\n<img src=\"https://raw.githubusercontent.com/fdsteffen/fretraj/master/docs/images/graphical_abstract.png\">\n\n## Installation and Documentation\nFollow the instructions for your platform [here](https://rna-fretools.github.io/fretraj/getting_started/installation)\n\n## References\nIf you use **FRETraj** in your work please refer to the following paper:\n\n- F.D. Steffen, R.K.O. Sigel, R. B\u00f6rner, *Bioinformatics* **2021**. [![](https://img.shields.io/badge/DOI-10.1093/bioinformatics/btab615-blue.svg)](https://doi.org/10.1093/bioinformatics/btab615)\n\n### Additional readings\n- F.D. Steffen, R.K.O. Sigel, R. B\u00f6rner, *Phys. Chem. Chem. Phys.* **2016**, *18*, 29045-29055.\n- S. Kalinin, T. Peulen, C.A.M. Seidel et al. *Nat. Methods*, **2012**, *9*, 1218-1225.\n- T. Eilert, M. Beckers, F. Drechsler, J. Michaelis, *Comput. Phys. Commun.*, **2017**, *219*, 377\u2013389.\n- M. Dimura, T. Peulen, C.A.M. Seidel et al. *Curr. Opin. Struct. Biol.* **2016**, *40*, 163-185.\n- M. Dimura, T. Peulen, C.A.M Seidel et al. *Nat. Commun.* **2020**, *11*, 5394.\n\n---\n\n<sup><a name=\"pymol\">1</a></sup> PyMOL was developed by WarrenDeLano and is maintained by Schr\u00f6dinger, LLC.\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "Predicting FRET with accessible-contact volumes",
"version": "0.2.10",
"project_urls": {
"Documentation": "https://rna-fretools.github.io/fretraj/",
"Homepage": "https://rna-fretools.github.io/",
"Repository": "https://github.com/RNA-FRETools/fretraj"
},
"split_keywords": [
"fret",
"single-molecule",
"molecular dynamics",
"pdb",
"structure prediction"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e235f0aa168930165fb0d6f74f6faa26580fce3d1ac89faf9dfaf8e45e9879b2",
"md5": "e7336733ff4a551eacecf163e29a8e02",
"sha256": "bd697b47c247c0c72c4e14a5759b68d7502b6db1ff02c3f675b3282d6807a15d"
},
"downloads": -1,
"filename": "fretraj-0.2.10-cp310-cp310-macosx_12_0_x86_64.whl",
"has_sig": false,
"md5_digest": "e7336733ff4a551eacecf163e29a8e02",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.8",
"size": 2071963,
"upload_time": "2023-10-22T18:30:58",
"upload_time_iso_8601": "2023-10-22T18:30:58.270877Z",
"url": "https://files.pythonhosted.org/packages/e2/35/f0aa168930165fb0d6f74f6faa26580fce3d1ac89faf9dfaf8e45e9879b2/fretraj-0.2.10-cp310-cp310-macosx_12_0_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6b3f5794f3ab786342abd6b850d662b8d0250f6fd855a86f8f1e386660fcbaba",
"md5": "52503c9e1cfdabf44804f05084ea5bd9",
"sha256": "05deb027a71b29ab4595b46eaf46f020f45ae51e39987c387fc804e56d03220c"
},
"downloads": -1,
"filename": "fretraj-0.2.10-cp310-cp310-manylinux_2_35_x86_64.whl",
"has_sig": false,
"md5_digest": "52503c9e1cfdabf44804f05084ea5bd9",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.8",
"size": 2079812,
"upload_time": "2023-10-22T18:31:00",
"upload_time_iso_8601": "2023-10-22T18:31:00.645227Z",
"url": "https://files.pythonhosted.org/packages/6b/3f/5794f3ab786342abd6b850d662b8d0250f6fd855a86f8f1e386660fcbaba/fretraj-0.2.10-cp310-cp310-manylinux_2_35_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "642bb6837a87f54aaef2243d16d07adb24c43834645ed5259a55c727884bf648",
"md5": "996fef543b4c4642567009ac95ab3604",
"sha256": "994a768ccee1ab55fa6d644a1aa55e01254931a47ee19df7433b1ff1f1db0dcc"
},
"downloads": -1,
"filename": "fretraj-0.2.10-cp310-cp310-win_amd64.whl",
"has_sig": false,
"md5_digest": "996fef543b4c4642567009ac95ab3604",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.8",
"size": 2070449,
"upload_time": "2023-10-22T18:31:02",
"upload_time_iso_8601": "2023-10-22T18:31:02.540624Z",
"url": "https://files.pythonhosted.org/packages/64/2b/b6837a87f54aaef2243d16d07adb24c43834645ed5259a55c727884bf648/fretraj-0.2.10-cp310-cp310-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "efb946b720146e83cb60532a37361864c42102b72b05ac5d1ef5440ec2e3e133",
"md5": "1d4689b200afe5ba45feb6132133f349",
"sha256": "6a8aa92e226527647bb08adc92671f0ddf79f0dfa57315780f4917592a273303"
},
"downloads": -1,
"filename": "fretraj-0.2.10-cp311-cp311-macosx_12_0_x86_64.whl",
"has_sig": false,
"md5_digest": "1d4689b200afe5ba45feb6132133f349",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.8",
"size": 2134382,
"upload_time": "2023-10-22T18:31:04",
"upload_time_iso_8601": "2023-10-22T18:31:04.531365Z",
"url": "https://files.pythonhosted.org/packages/ef/b9/46b720146e83cb60532a37361864c42102b72b05ac5d1ef5440ec2e3e133/fretraj-0.2.10-cp311-cp311-macosx_12_0_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "88a608f7ecb12beb9d17bc3688a091b53ac99cb4a137137a1003240ad9642624",
"md5": "d00f79a25831655d28712c4e4a21f32b",
"sha256": "4a385c514b34dbb4ff9524ff5293480cfd8ec8ee4e0fd2baefa9b5b31e3dc280"
},
"downloads": -1,
"filename": "fretraj-0.2.10-cp311-cp311-manylinux_2_35_x86_64.whl",
"has_sig": false,
"md5_digest": "d00f79a25831655d28712c4e4a21f32b",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.8",
"size": 2081562,
"upload_time": "2023-10-22T18:31:06",
"upload_time_iso_8601": "2023-10-22T18:31:06.156025Z",
"url": "https://files.pythonhosted.org/packages/88/a6/08f7ecb12beb9d17bc3688a091b53ac99cb4a137137a1003240ad9642624/fretraj-0.2.10-cp311-cp311-manylinux_2_35_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d86cf54d156658791510dfabed802a89fd4fa60fbb8eef7598e51272aca722fe",
"md5": "55fd082fe3b11fd43e8bbed76bc297d0",
"sha256": "89348b50b111201960126d54c2b886238dd88c980426f83c96488ac9f998e644"
},
"downloads": -1,
"filename": "fretraj-0.2.10-cp311-cp311-win_amd64.whl",
"has_sig": false,
"md5_digest": "55fd082fe3b11fd43e8bbed76bc297d0",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.8",
"size": 2071180,
"upload_time": "2023-10-22T18:31:08",
"upload_time_iso_8601": "2023-10-22T18:31:08.010581Z",
"url": "https://files.pythonhosted.org/packages/d8/6c/f54d156658791510dfabed802a89fd4fa60fbb8eef7598e51272aca722fe/fretraj-0.2.10-cp311-cp311-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e473399af89bf5e8c8c039b437ee1f8999c4918b1e604d0da4d0e56325f908c6",
"md5": "db436c7a265bbe1bd0fe0023914eb233",
"sha256": "2813df472d2c44ce61598820c90223234af1208645a472656a44e595277aec20"
},
"downloads": -1,
"filename": "fretraj-0.2.10.tar.gz",
"has_sig": false,
"md5_digest": "db436c7a265bbe1bd0fe0023914eb233",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 1995868,
"upload_time": "2023-10-22T18:31:10",
"upload_time_iso_8601": "2023-10-22T18:31:10.156022Z",
"url": "https://files.pythonhosted.org/packages/e4/73/399af89bf5e8c8c039b437ee1f8999c4918b1e604d0da4d0e56325f908c6/fretraj-0.2.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-22 18:31:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "RNA-FRETools",
"github_project": "fretraj",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "fretraj"
}