IMDClient

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

Receiver for IMDv3 protocol from simulation engines like Gromacs, LAMMPS, and NAMD.

IMDClient is bound by a Code of Conduct.

Installation

IMDClient requires Python 3.11 or higher.

Install via mamba (recommended)

To install the latest release of IMDClient from conda-forge:

mamba install -c conda-forge imdclient

Install via pip

To install the latest release of IMDClient from PyPI:

pip install imdclient

Building from Source

To build IMDClient from source, we highly recommend using virtual environments. If possible, we recommend that you use mamba as your package manager through miniforge. (You can substitute conda for mamba in the commands below if you prefer.)

Below we provide instructions both for mamba and for pip.

Source build with mamba

  1. Ensure you have mamba installed.

  2. Create and activate a new environment:

mamba create --name imdclient
mamba activate imdclient
  1. (Recommended) Install all dependencies using the provided environment YAML files for a clean and reproducible environment:
mamba env update --name imdclient --file devtools/conda-envs/test_env.yaml
mamba env update --name imdclient --file docs/requirements.yaml
  1. Build and install IMDClient in editable mode:
pip install -e .
  1. (Optional) Update dependencies:
mamba update --all
  1. Deactivate the environment when finished:
mamba deactivate

Source build with pip

  1. (Optional) Create and activate a virtual environment:
python -m venv venv
source venv/bin/activate
  1. Install IMDClient from source:
pip install .
  1. (Optional) For development (tests and docs):
pip install ".[test,doc]"

Copyright

The IMDClient source code is hosted at https://github.com/becksteinlab/imdclient and is available under the MIT license (see the file LICENSE).

Copyright (c) 2024-2025, imdclient AUTHORS

Acknowledgements

Project based on the MDAnalysis Cookiecutter version 0.1.

If you use IMDClient in your research, please cite IMDClient in your publications.

Project links

Data verified by PyPI on Jul 13, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

3 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for hcho38 from gravatar.com hcho38 Avatar for ljwoods2 from gravatar.com ljwoods2 Avatar for Oliver.Beckstein from gravatar.com Oliver.Beckstein

Credits

Author: Lawson Woods

Maintainer: Lawson Woods

GitHub Statistics

Data verified by PyPI on Jul 13, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

MIT
View SPDX License List

Requires

Python >=3.11

Provides Extra

test doc

Tags

molecular simulations

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

imdclient-0.2.4.tar.gz (589.5 kB view details)

Uploaded Source

Built Distribution

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

imdclient-0.2.4-py3-none-any.whl (595.2 kB view details)

Uploaded Python 3

File details

Details for the file imdclient-0.2.4.tar.gz.

File metadata

  • Download URL: imdclient-0.2.4.tar.gz
  • Upload date:
  • Size: 589.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for imdclient-0.2.4.tar.gz
Algorithm Hash digest
SHA256 ec8adf3eca29a1b8abcf784226f2832aa63474bed1c6be9dc79d3e6dd0b8fc74
MD5 125946b6391ac7f283133c9340e40137
BLAKE2b-256 3c5698ba18101d165a9fe0b7e42fb1ac139786f9d29ea4200a314173465176ee

See more details on using hashes here.

Provenance

The following attestation bundles were made for imdclient-0.2.4.tar.gz:

Publisher: deploy.yaml on Becksteinlab/imdclient

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

File details

Details for the file imdclient-0.2.4-py3-none-any.whl.

File metadata

  • Download URL: imdclient-0.2.4-py3-none-any.whl
  • Upload date:
  • Size: 595.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for imdclient-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 97efc0ef12bbb24c37d02848d794061d9dc246f1048145d9caed4c1d3b14721b
MD5 7feaba335703ac5052ae046ed17c485b
BLAKE2b-256 0e5bbb2c7e9a0ff432bdfde514255c889ea898297cfc15b1c2157b5d35810d7f

See more details on using hashes here.

Provenance

The following attestation bundles were made for imdclient-0.2.4-py3-none-any.whl:

Publisher: deploy.yaml on Becksteinlab/imdclient

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

Supported by

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