Skip to main content

Quantile-based estimation of local diffusivities in molecular dynamics simulations of nanoconfined liquids

Project description

qdiffusivity

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

Quantile-based estimation of local diffusivities in molecular dynamics simulations of nanoconfined liquids

qdiffusivity is bound by a Code of Conduct.

Installation

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

Install the development and documentation dependencies:

conda env update --name qdiffusivity --file devtools/conda-envs/test_env.yaml
conda env update --name qdiffusivity --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 qdiffusivity source code is hosted at https://github.com/srtee/qdiffusivity and is available under the MIT License (see the file LICENSE).

Copyright (c) 2026, Shern Ren Tee

Acknowledgements

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

qdiffusivity-0.2.0.tar.gz (39.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

qdiffusivity-0.2.0-py3-none-any.whl (39.9 kB view details)

Uploaded Python 3

File details

Details for the file qdiffusivity-0.2.0.tar.gz.

File metadata

  • Download URL: qdiffusivity-0.2.0.tar.gz
  • Upload date:
  • Size: 39.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.14 {"installer":{"name":"uv","version":"0.11.14","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Manjaro Linux","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for qdiffusivity-0.2.0.tar.gz
Algorithm Hash digest
SHA256 b04f6837f603d3f13e99a7a53ac36a91773c8ccdd8e2414b384c05b4c4e5a475
MD5 7c422e280acba3f3255085821001b8b5
BLAKE2b-256 5fe372c6ddab845959f4a12cb402dbc61526bdf74e9cf6894e4fbb99b73f804c

See more details on using hashes here.

File details

Details for the file qdiffusivity-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: qdiffusivity-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 39.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.14 {"installer":{"name":"uv","version":"0.11.14","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Manjaro Linux","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for qdiffusivity-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cd8513e093e1124809bcfe0489ae1982138f807a3e7d5ec665cccad21557b894
MD5 6476d4e5c593bfe4c1667e3f39c70da4
BLAKE2b-256 2a56a5d87b9767a3dfd881a1f24e3246dcb9ee9768f8207031ca5acd0566b1b1

See more details on using hashes here.

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