Skip to content

Aryaman-Chaudhri/MDAnalysis-lDDT

lDDT

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

An MDAnalysis Toolkit (MDAKit) to calculate the lDDT (Local Distance Difference Test) score.

lDDT is bound by a Code of Conduct.

Installation

To build lDDT 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 MDAnalysis-lDDT
conda activate MDAnalysis-lDDT

Install the development and documentation dependencies:

conda env update --name MDAnalysis-lDDT --file devtools/conda-envs/test_env.yaml
conda env update --name MDAnalysis-lDDT --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 lDDT source code is hosted at https://github.com/Aryaman-Chaudhri/MDAnalysis-lDDT and is available under the GNU General Public License, version 2 (see the file LICENSE).

Copyright (c) 2025, Aryaman Chaudhri

Acknowledgements

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

About

An MDAnalysis Toolkit (MDAKit) to calculate the lDDT (Local Distance Difference Test) score.

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages