basicrta


Namebasicrta JSON
Version 1.1.1 PyPI version JSON
download
home_pageNone
SummaryA package to extract binding kinetics from molecular dynamics simulations
upload_time2025-07-19 00:09:49
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseNone
keywords molecular simulations
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Bayesian Single-Cutoff Residence Time Analysis (basicrta)
==============================
[//]: # (Badges)

| **Latest release** | [![Last release tag][badge_release]][url_latest_release] ![GitHub commits since latest release (by date) for a branch][badge_commits_since]  [![Documentation Status][badge_docs]][url_docs]|
| :----------------- | :------- |
| **Archives**       | [![DOI][badge_zenodo]][url_zenodo] |
| **Status**         | [![GH Actions Status][badge_actions]][url_actions] [![codecov][badge_codecov]][url_codecov] |
| **Community**      | [![License: GPL v3][badge_license]][url_license]  [![Powered by MDAnalysis][badge_mda]][url_mda]|

[badge_actions]: https://github.com/becksteinlab/basicrta/actions/workflows/gh-ci.yaml/badge.svg
[badge_codecov]: https://codecov.io/gh/becksteinlab/basicrta/branch/main/graph/badge.svg
[badge_commits_since]: https://img.shields.io/github/commits-since/becksteinlab/basicrta/latest
[badge_docs]: https://readthedocs.org/projects/basicrta/badge/?version=latest
[badge_license]: https://img.shields.io/badge/License-GPLv3-blue.svg
[badge_zenodo]: https://zenodo.org/badge/DOI/10.5281/zenodo.13877225.svg 
[badge_mda]: https://img.shields.io/badge/powered%20by-MDAnalysis-orange.svg?logoWidth=16&logo=data:image/x-icon;base64,AAABAAEAEBAAAAEAIAAoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAJD+XwCY/fEAkf3uAJf97wGT/a+HfHaoiIWE7n9/f+6Hh4fvgICAjwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACT/yYAlP//AJ///wCg//8JjvOchXly1oaGhv+Ghob/j4+P/39/f3IAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAJH8aQCY/8wAkv2kfY+elJ6al/yVlZX7iIiI8H9/f7h/f38UAAAAAAAAAAAAAAAAAAAAAAAAAAB/f38egYF/noqAebF8gYaagnx3oFpUUtZpaWr/WFhY8zo6OmT///8BAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAgICAn46Ojv+Hh4b/jouJ/4iGhfcAAADnAAAA/wAAAP8AAADIAAAAAwCj/zIAnf2VAJD/PAAAAAAAAAAAAAAAAICAgNGHh4f/gICA/4SEhP+Xl5f/AwMD/wAAAP8AAAD/AAAA/wAAAB8Aov9/ALr//wCS/Z0AAAAAAAAAAAAAAACBgYGOjo6O/4mJif+Pj4//iYmJ/wAAAOAAAAD+AAAA/wAAAP8AAABhAP7+FgCi/38Axf4fAAAAAAAAAAAAAAAAiIiID4GBgYKCgoKogoB+fYSEgZhgYGDZXl5e/m9vb/9ISEjpEBAQxw8AAFQAAAAAAAAANQAAADcAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAjo6Mb5iYmP+cnJz/jY2N95CQkO4pKSn/AAAA7gAAAP0AAAD7AAAAhgAAAAEAAAAAAAAAAACL/gsAkv2uAJX/QQAAAAB9fX3egoKC/4CAgP+NjY3/c3Nz+wAAAP8AAAD/AAAA/wAAAPUAAAAcAAAAAAAAAAAAnP4NAJL9rgCR/0YAAAAAfX19w4ODg/98fHz/i4uL/4qKivwAAAD/AAAA/wAAAP8AAAD1AAAAGwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAALGxsVyqqqr/mpqa/6mpqf9KSUn/AAAA5QAAAPkAAAD5AAAAhQAAAAEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAADkUFBSuZ2dn/3V1df8uLi7bAAAATgBGfyQAAAA2AAAAMwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAB0AAADoAAAA/wAAAP8AAAD/AAAAWgC3/2AAnv3eAJ/+dgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA9AAAA/wAAAP8AAAD/AAAA/wAKDzEAnP3WAKn//wCS/OgAf/8MAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAIQAAANwAAADtAAAA7QAAAMAAABUMAJn9gwCe/e0Aj/2LAP//AQAAAAAAAAAA
[badge_release]: https://img.shields.io/github/release-pre/becksteinlab/basicrta.svg
[url_actions]: https://github.com/becksteinlab/basicrta/actions?query=branch%3Amain+workflow%3Agh-ci
[url_codecov]: https://codecov.io/gh/becksteinlab/basicrta/branch/main
[url_docs]: https://basicrta.readthedocs.io/en/latest/?badge=latest
[url_latest_release]: https://github.com/becksteinlab/basicrta/releases
[url_license]: https://www.gnu.org/licenses/gpl-2.0
[url_mda]: https://www.mdanalysis.org
[url_zenodo]: https://doi.org/10.5281/zenodo.13877225

A package to extract binding kinetics from molecular dynamics simulations based
on Sexton (2025) [^1]. 

[^1]: Sexton, R.; Fazel, M.; Schweiger, M.; Pressé, S.; Beckstein, O. Bayesian Nonparametric Analysis of Residence Times for 
   Protein-Lipid Interactions in Molecular Dynamics Simulations. *Journal of Chemical Theory and Computation* 
   **2025** *21* (8), 4203-4220
   DOI: `10.1021/acs.jctc.4c01522 <http://doi.org/10.1021/acs.jctc.4c01522>`_ 

basicrta is bound by a [Code of Conduct](https://github.com/becksteinlab/basicrta/blob/main/CODE_OF_CONDUCT.md).

### Installation

To build basicrta from source,
we highly recommend using virtual environments.
If possible, we strongly recommend that you use
[Anaconda](https://docs.conda.io/en/latest/) as your package manager.
Below we provide instructions both for `conda` and
for `pip`.

#### With conda

Ensure that you have [conda](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html) installed.

Create a virtual environment and activate it:

```
conda create --name basicrta
conda activate basicrta
```

Install the development and documentation dependencies:

```
conda env update --name basicrta --file devtools/conda-envs/test_env.yaml
conda env update --name basicrta --file docs/requirements.yaml
```

Build this package from source:

```
pip install -e .
```

If you want to update your dependencies (which can be risky!), run:

```
conda update --all
```

And when you are finished, you can exit the virtual environment with:

```
conda deactivate
```

#### With pip

To build the package from source, run:

```
pip install .
```

If you want to create a development environment, install
the dependencies required for tests and docs with:

```
pip install ".[test,doc]"
```

### Copyright

The basicrta source code is hosted at https://github.com/becksteinlab/basicrta
and is available under the GNU General Public License, version 3 (see the file [LICENSE](https://github.com/becksteinlab/basicrta/blob/main/LICENSE)).

Copyright (c) 2024, Ricky Sexton


#### Acknowledgements
 
Project based on the 
[MDAnalysis Cookiecutter](https://github.com/MDAnalysis/cookiecutter-mda) version 0.1.
Please cite [MDAnalysis](https://github.com/MDAnalysis/mdanalysis#citation) when using basicrta in published work.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "basicrta",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": "Ricky Sexton <risexto878@gmail.com>",
    "keywords": "molecular simulations",
    "author": null,
    "author_email": "Ricky Sexton <risexto878@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/21/60/37a51e53c1736e8b7236714cf6a47ccfbc0456f10929b184f40987a0a86d/basicrta-1.1.1.tar.gz",
    "platform": null,
    "description": "Bayesian Single-Cutoff Residence Time Analysis (basicrta)\n==============================\n[//]: # (Badges)\n\n| **Latest release** | [![Last release tag][badge_release]][url_latest_release] ![GitHub commits since latest release (by date) for a branch][badge_commits_since]  [![Documentation Status][badge_docs]][url_docs]|\n| :----------------- | :------- |\n| **Archives**       | [![DOI][badge_zenodo]][url_zenodo] |\n| **Status**         | [![GH Actions Status][badge_actions]][url_actions] [![codecov][badge_codecov]][url_codecov] |\n| **Community**      | [![License: GPL v3][badge_license]][url_license]  [![Powered by MDAnalysis][badge_mda]][url_mda]|\n\n[badge_actions]: https://github.com/becksteinlab/basicrta/actions/workflows/gh-ci.yaml/badge.svg\n[badge_codecov]: https://codecov.io/gh/becksteinlab/basicrta/branch/main/graph/badge.svg\n[badge_commits_since]: https://img.shields.io/github/commits-since/becksteinlab/basicrta/latest\n[badge_docs]: https://readthedocs.org/projects/basicrta/badge/?version=latest\n[badge_license]: https://img.shields.io/badge/License-GPLv3-blue.svg\n[badge_zenodo]: https://zenodo.org/badge/DOI/10.5281/zenodo.13877225.svg \n[badge_mda]: https://img.shields.io/badge/powered%20by-MDAnalysis-orange.svg?logoWidth=16&logo=data:image/x-icon;base64,AAABAAEAEBAAAAEAIAAoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAJD+XwCY/fEAkf3uAJf97wGT/a+HfHaoiIWE7n9/f+6Hh4fvgICAjwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACT/yYAlP//AJ///wCg//8JjvOchXly1oaGhv+Ghob/j4+P/39/f3IAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAJH8aQCY/8wAkv2kfY+elJ6al/yVlZX7iIiI8H9/f7h/f38UAAAAAAAAAAAAAAAAAAAAAAAAAAB/f38egYF/noqAebF8gYaagnx3oFpUUtZpaWr/WFhY8zo6OmT///8BAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAgICAn46Ojv+Hh4b/jouJ/4iGhfcAAADnAAAA/wAAAP8AAADIAAAAAwCj/zIAnf2VAJD/PAAAAAAAAAAAAAAAAICAgNGHh4f/gICA/4SEhP+Xl5f/AwMD/wAAAP8AAAD/AAAA/wAAAB8Aov9/ALr//wCS/Z0AAAAAAAAAAAAAAACBgYGOjo6O/4mJif+Pj4//iYmJ/wAAAOAAAAD+AAAA/wAAAP8AAABhAP7+FgCi/38Axf4fAAAAAAAAAAAAAAAAiIiID4GBgYKCgoKogoB+fYSEgZhgYGDZXl5e/m9vb/9ISEjpEBAQxw8AAFQAAAAAAAAANQAAADcAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAjo6Mb5iYmP+cnJz/jY2N95CQkO4pKSn/AAAA7gAAAP0AAAD7AAAAhgAAAAEAAAAAAAAAAACL/gsAkv2uAJX/QQAAAAB9fX3egoKC/4CAgP+NjY3/c3Nz+wAAAP8AAAD/AAAA/wAAAPUAAAAcAAAAAAAAAAAAnP4NAJL9rgCR/0YAAAAAfX19w4ODg/98fHz/i4uL/4qKivwAAAD/AAAA/wAAAP8AAAD1AAAAGwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAALGxsVyqqqr/mpqa/6mpqf9KSUn/AAAA5QAAAPkAAAD5AAAAhQAAAAEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAADkUFBSuZ2dn/3V1df8uLi7bAAAATgBGfyQAAAA2AAAAMwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAB0AAADoAAAA/wAAAP8AAAD/AAAAWgC3/2AAnv3eAJ/+dgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA9AAAA/wAAAP8AAAD/AAAA/wAKDzEAnP3WAKn//wCS/OgAf/8MAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAIQAAANwAAADtAAAA7QAAAMAAABUMAJn9gwCe/e0Aj/2LAP//AQAAAAAAAAAA\n[badge_release]: https://img.shields.io/github/release-pre/becksteinlab/basicrta.svg\n[url_actions]: https://github.com/becksteinlab/basicrta/actions?query=branch%3Amain+workflow%3Agh-ci\n[url_codecov]: https://codecov.io/gh/becksteinlab/basicrta/branch/main\n[url_docs]: https://basicrta.readthedocs.io/en/latest/?badge=latest\n[url_latest_release]: https://github.com/becksteinlab/basicrta/releases\n[url_license]: https://www.gnu.org/licenses/gpl-2.0\n[url_mda]: https://www.mdanalysis.org\n[url_zenodo]: https://doi.org/10.5281/zenodo.13877225\n\nA package to extract binding kinetics from molecular dynamics simulations based\non Sexton (2025) [^1]. \n\n[^1]: Sexton, R.; Fazel, M.; Schweiger, M.; Press\u00e9, S.; Beckstein, O. Bayesian Nonparametric Analysis of Residence Times for \n   Protein-Lipid Interactions in Molecular Dynamics Simulations. *Journal of Chemical Theory and Computation* \n   **2025** *21* (8), 4203-4220\n   DOI: `10.1021/acs.jctc.4c01522 <http://doi.org/10.1021/acs.jctc.4c01522>`_ \n\nbasicrta is bound by a [Code of Conduct](https://github.com/becksteinlab/basicrta/blob/main/CODE_OF_CONDUCT.md).\n\n### Installation\n\nTo build basicrta from source,\nwe highly recommend using virtual environments.\nIf possible, we strongly recommend that you use\n[Anaconda](https://docs.conda.io/en/latest/) as your package manager.\nBelow we provide instructions both for `conda` and\nfor `pip`.\n\n#### With conda\n\nEnsure that you have [conda](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html) installed.\n\nCreate a virtual environment and activate it:\n\n```\nconda create --name basicrta\nconda activate basicrta\n```\n\nInstall the development and documentation dependencies:\n\n```\nconda env update --name basicrta --file devtools/conda-envs/test_env.yaml\nconda env update --name basicrta --file docs/requirements.yaml\n```\n\nBuild this package from source:\n\n```\npip install -e .\n```\n\nIf you want to update your dependencies (which can be risky!), run:\n\n```\nconda update --all\n```\n\nAnd when you are finished, you can exit the virtual environment with:\n\n```\nconda deactivate\n```\n\n#### With pip\n\nTo build the package from source, run:\n\n```\npip install .\n```\n\nIf you want to create a development environment, install\nthe dependencies required for tests and docs with:\n\n```\npip install \".[test,doc]\"\n```\n\n### Copyright\n\nThe basicrta source code is hosted at https://github.com/becksteinlab/basicrta\nand is available under the GNU General Public License, version 3 (see the file [LICENSE](https://github.com/becksteinlab/basicrta/blob/main/LICENSE)).\n\nCopyright (c) 2024, Ricky Sexton\n\n\n#### Acknowledgements\n \nProject based on the \n[MDAnalysis Cookiecutter](https://github.com/MDAnalysis/cookiecutter-mda) version 0.1.\nPlease cite [MDAnalysis](https://github.com/MDAnalysis/mdanalysis#citation) when using basicrta in published work.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A package to extract binding kinetics from molecular dynamics simulations",
    "version": "1.1.1",
    "project_urls": {
        "documentation": "https://basicrta.readthedocs.io",
        "source": "https://github.com/becksteinlab/basicrta"
    },
    "split_keywords": [
        "molecular",
        "simulations"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "abb8bc5ed60e5509c539c1496c314fcea663030c119055c38938cbc0b7eedb6a",
                "md5": "f3895fceecfb89bb17228b931c5cc587",
                "sha256": "2973916faf80f369f0a4add9347c82f83a5ea9c9457e580343effa5177a1bdd9"
            },
            "downloads": -1,
            "filename": "basicrta-1.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f3895fceecfb89bb17228b931c5cc587",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 791167,
            "upload_time": "2025-07-19T00:09:48",
            "upload_time_iso_8601": "2025-07-19T00:09:48.512563Z",
            "url": "https://files.pythonhosted.org/packages/ab/b8/bc5ed60e5509c539c1496c314fcea663030c119055c38938cbc0b7eedb6a/basicrta-1.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "216037a51e53c1736e8b7236714cf6a47ccfbc0456f10929b184f40987a0a86d",
                "md5": "3c61431dcf45b56e78534dfd69ec0b3a",
                "sha256": "d2bb78cd9625f114c91f55c40e6f5f9f1e487369ee725082b0e7dd785865f6a9"
            },
            "downloads": -1,
            "filename": "basicrta-1.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "3c61431dcf45b56e78534dfd69ec0b3a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 780056,
            "upload_time": "2025-07-19T00:09:49",
            "upload_time_iso_8601": "2025-07-19T00:09:49.905832Z",
            "url": "https://files.pythonhosted.org/packages/21/60/37a51e53c1736e8b7236714cf6a47ccfbc0456f10929b184f40987a0a86d/basicrta-1.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-19 00:09:49",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "becksteinlab",
    "github_project": "basicrta",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "basicrta"
}
        
Elapsed time: 1.61389s