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.1.tar.gz (780.1 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.1-py3-none-any.whl (791.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: basicrta-1.1.1.tar.gz
  • Upload date:
  • Size: 780.1 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.1.tar.gz
Algorithm Hash digest
SHA256 d2bb78cd9625f114c91f55c40e6f5f9f1e487369ee725082b0e7dd785865f6a9
MD5 3c61431dcf45b56e78534dfd69ec0b3a
BLAKE2b-256 216037a51e53c1736e8b7236714cf6a47ccfbc0456f10929b184f40987a0a86d

See more details on using hashes here.

Provenance

The following attestation bundles were made for basicrta-1.1.1.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.1-py3-none-any.whl.

File metadata

  • Download URL: basicrta-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 791.2 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2973916faf80f369f0a4add9347c82f83a5ea9c9457e580343effa5177a1bdd9
MD5 f3895fceecfb89bb17228b931c5cc587
BLAKE2b-256 abb8bc5ed60e5509c539c1496c314fcea663030c119055c38938cbc0b7eedb6a

See more details on using hashes here.

Provenance

The following attestation bundles were made for basicrta-1.1.1-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