Skip to content

cabb99/qvalue

Repository files navigation

Qvalue

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

"Calculates the fraction of native contacts conserved during the simulation"

Qvalue is bound by a Code of Conduct.

Installation

To build Qvalue 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 qvalue
conda activate qvalue

Install the development and documentation dependencies:

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

Copyright (c) 2024, Carlos Bueno

Acknowledgements

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

About

No description, website, or topics provided.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published