https://github.com/becksteinlab/imdclient

Streaming analysis from running MD simulations.

https://github.com/becksteinlab/imdclient

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
    1 of 7 committers (14.3%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.3%) to scientific vocabulary

Keywords

md mdanalysis python science streaming

Keywords from Contributors

molecular-dynamics
Last synced: 5 months ago · JSON representation

Repository

Streaming analysis from running MD simulations.

Basic Info
Statistics
  • Stars: 7
  • Watchers: 3
  • Forks: 2
  • Open Issues: 17
  • Releases: 13
Topics
md mdanalysis python science streaming
Created over 1 year ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Authors

README.md

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.10 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.

Owner

  • Name: Becksteinlab
  • Login: Becksteinlab
  • Kind: organization
  • Email: obeckste@asu.edu
  • Location: Tempe, AZ

Computational Biophysics at Arizona State University

GitHub Events

Total
  • Create event: 36
  • Release event: 10
  • Issues event: 69
  • Watch event: 6
  • Delete event: 32
  • Issue comment event: 159
  • Push event: 167
  • Pull request review event: 147
  • Pull request review comment event: 138
  • Pull request event: 64
  • Fork event: 2
Last Year
  • Create event: 36
  • Release event: 10
  • Issues event: 69
  • Watch event: 6
  • Delete event: 32
  • Issue comment event: 159
  • Push event: 167
  • Pull request review event: 147
  • Pull request review comment event: 138
  • Pull request event: 64
  • Fork event: 2

Committers

Last synced: over 1 year ago

All Time
  • Total Commits: 81
  • Total Committers: 7
  • Avg Commits per committer: 11.571
  • Development Distribution Score (DDS): 0.198
Past Year
  • Commits: 81
  • Committers: 7
  • Avg Commits per committer: 11.571
  • Development Distribution Score (DDS): 0.198
Top Committers
Name Email Commits
ljwoods2 l****2@a****u 65
hcho38 h****6@g****m 5
ljwoods2 1****2 4
ljwoods2 l****4@g****m 3
Amruthesh Thirumalaiswamy a****t 2
Oliver Beckstein o****t@g****m 1
hcho38 h****6@g****m 1
Committer Domains (Top 20 + Academic)
asu.edu: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 51
  • Total pull requests: 75
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 7 days
  • Total issue authors: 4
  • Total pull request authors: 7
  • Average comments per issue: 1.1
  • Average comments per pull request: 1.4
  • Merged pull requests: 57
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 44
  • Pull requests: 75
  • Average time to close issues: 23 days
  • Average time to close pull requests: 7 days
  • Issue authors: 4
  • Pull request authors: 7
  • Average comments per issue: 1.05
  • Average comments per pull request: 1.4
  • Merged pull requests: 57
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • ljwoods2 (24)
  • orbeckst (23)
  • hmacdope (2)
  • amruthesht (2)
Pull Request Authors
  • ljwoods2 (40)
  • amruthesht (13)
  • orbeckst (12)
  • hcho38 (5)
  • hmacdope (3)
  • jaclark5 (2)
  • Copilot (1)
Top Labels
Issue Labels
CI/CD (5) bug (4) documentation (3) release (3) testing (2) installation (2)
Pull Request Labels
documentation (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 414 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 11
  • Total maintainers: 3
pypi.org: imdclient

Receiver for IMD v2 and v3 data from simulation engines like Gromacs, LAMMPS, and NAMD

  • Versions: 11
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 414 Last month
Rankings
Dependent packages count: 10.2%
Average: 33.8%
Dependent repos count: 57.4%
Maintainers (3)
Last synced: 6 months ago

Dependencies

.github/workflows/gh-ci.yaml actions
  • MDAnalysis/install-mdanalysis main composite
  • MDAnalysis/mdanalysis-compatible-python main composite
  • actions/checkout v4 composite
  • actions/setup-python v4 composite
  • codecov/codecov-action v3 composite
  • conda-incubator/setup-miniconda v2 composite
pyproject.toml pypi
  • MDAnalysis >=2.7.0
.github/workflows/deploy.yaml actions
  • actions/checkout v4 composite
  • actions/download-artifact v4 composite
  • actions/setup-python v5 composite
  • actions/upload-artifact v4 composite
  • pypa/gh-action-pypi-publish v1.9.0 composite