Skip to main content

Analysis of water dynamics in molecular dynamics trajectories and water interactions with other molecules.

Project description

waterdynamics

Latest release Last release tag GitHub commits since latest release (by date) for a branch
Status GH Actions Status codecov Docs
Community Powered by MDAnalysis

Analysis of water dynamics in molecular dynamics trajectories and water interactions with other molecules. Documentation for waterdynamics can be found at https://mdanalysis.org/waterdynamics.

waterdynamics is bound by a Code of Conduct.

Installation

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

Install the development and documentation dependencies:

conda env update --name waterdynamics --file devtools/conda-envs/test_env.yaml
conda env update --name waterdynamics --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

Install from PyPI

The latest release of waterdynamics is available on PyPI and can be installed with:

pip install waterdynamics
Install from source

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 waterdynamics source code is hosted at https://github.com/MDAnalysis/waterdynamics and is available under the Lesser GNU General Public License, version 2.1 or later (see the file LICENSE).

Copyright (c) 2023, MDAnalysis

Acknowledgements

Project based on the MDAnalysis Cookiecutter version 0.1. Please cite MDAnalysis when using waterdynamics 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

waterdynamics-1.2.0.tar.gz (46.1 kB view details)

Uploaded Source

Built Distribution

waterdynamics-1.2.0-py3-none-any.whl (35.0 kB view details)

Uploaded Python 3

File details

Details for the file waterdynamics-1.2.0.tar.gz.

File metadata

  • Download URL: waterdynamics-1.2.0.tar.gz
  • Upload date:
  • Size: 46.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for waterdynamics-1.2.0.tar.gz
Algorithm Hash digest
SHA256 ab87ca22c46db71cf72b2c5534fbd062fd853d999cee9c10587932217cd40c96
MD5 1ab287a5e5e1fea7897b8ffe807e92bc
BLAKE2b-256 8d6f29e972e598bbc5bb1bfe7fe346e91b06c92730bec69783c9cfe15c6c04d6

See more details on using hashes here.

Provenance

The following attestation bundles were made for waterdynamics-1.2.0.tar.gz:

Publisher: deploy.yaml on MDAnalysis/waterdynamics

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

File details

Details for the file waterdynamics-1.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for waterdynamics-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8a9eb7e7ad44e2abf9e2542661b2d7b371d8ab6474113a301968e4bf78d4432d
MD5 e7560ea422e14bf1e57928deb75797b6
BLAKE2b-256 0e31412badf1d9e9beb63f949037c79d0abb43857db068de00cb8e9aefa6fbc4

See more details on using hashes here.

Provenance

The following attestation bundles were made for waterdynamics-1.2.0-py3-none-any.whl:

Publisher: deploy.yaml on MDAnalysis/waterdynamics

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

Supported by

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