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 License: GPL v2 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 GNU General Public License, version 2 (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.1.0.tar.gz (36.3 kB view details)

Uploaded Source

Built Distribution

waterdynamics-1.1.0-py3-none-any.whl (29.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: waterdynamics-1.1.0.tar.gz
  • Upload date:
  • Size: 36.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for waterdynamics-1.1.0.tar.gz
Algorithm Hash digest
SHA256 1469aeb0044c8804e83069d65b80978de27f7bfc38e6035d38329f075652f1db
MD5 abe940cf369098dbfd495ff5d3bcd635
BLAKE2b-256 860e51335d3f0db3737ad6124edc3d9b82fb0c2d11c2029c96341d38340582b6

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for waterdynamics-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ca8f72704b0477927fc9afaab87b627882b94e97360bd43f2ba0a41a6bea39bb
MD5 e3eb0e881c3481eb4053bfc4dfc7838c
BLAKE2b-256 57b3b2be07a8f6a98effc535d99c96eef1e81d9ddfdcb177032494ed8226d2d2

See more details on using hashes here.

Provenance

Supported by

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