Skip to main content

A package to extract binding kinetics from molecular dynamics simulations

Project description

Bayesian Single-Cutoff Residence Time Analysis (basicrta)

Latest release Last release tag GitHub commits since latest release (by date) for a branch Documentation Status
Archives DOI
Status GH Actions Status codecov
Community License: GPL v3 Powered by MDAnalysis

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.

Installation

To build basicrta from source, we highly recommend using virtual environments. If possible, we strongly recommend that you use Anaconda as your package manager. Below we provide instructions both for conda and for pip.

With conda

Ensure that you have conda 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).

Copyright (c) 2024, Ricky Sexton

Acknowledgements

Project based on the MDAnalysis Cookiecutter version 0.1. Please cite MDAnalysis when using basicrta in published work.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

basicrta-1.1.2.tar.gz (787.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

basicrta-1.1.2-py3-none-any.whl (798.7 kB view details)

Uploaded Python 3

File details

Details for the file basicrta-1.1.2.tar.gz.

File metadata

  • Download URL: basicrta-1.1.2.tar.gz
  • Upload date:
  • Size: 787.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for basicrta-1.1.2.tar.gz
Algorithm Hash digest
SHA256 17f107cc677e532596f738188914bf67b06159a181dfe3824be9997ae98ce068
MD5 0bcdc4533f053c46c59cb578b8f8c2d2
BLAKE2b-256 f5e9af8b147ea77f4df7db00177d493f2f24924c9df02305118b3dbedbae8d00

See more details on using hashes here.

Provenance

The following attestation bundles were made for basicrta-1.1.2.tar.gz:

Publisher: deploy.yaml on Becksteinlab/basicrta

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file basicrta-1.1.2-py3-none-any.whl.

File metadata

  • Download URL: basicrta-1.1.2-py3-none-any.whl
  • Upload date:
  • Size: 798.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for basicrta-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1ee2a2d6654a63bc03ff41214e90733e07aaa730aa88bde5b9b1fa5f97a696a8
MD5 6d0a2049c5c4b12663a959b70b6e8e4e
BLAKE2b-256 5288156256e8ede7d3ba612afb99d16f6f8464abed2b5571dff84bf3f1e29fc9

See more details on using hashes here.

Provenance

The following attestation bundles were made for basicrta-1.1.2-py3-none-any.whl:

Publisher: deploy.yaml on Becksteinlab/basicrta

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page