mdadash

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
Packages conda mdadash PyPi mdadash

MDAnalysis Dashboard

Dashboard for tracking and analyzing live MD simulations with streaming.

mdadash is bound by a Code of Conduct.

Getting Started

Installation

mdadash can be installed in any of the following ways depending on your Python environment:

pip install mdadash

or

uv add mdadash

or

conda install -c conda-forge mdadash

or

mamba install -c conda-forge mdadash

To execute directly from an isolated environment without installing:

uvx mdadash -h

Run

Once the package is installed, it can be run using the mdadash command to start the dashboard server:

mdadash --topology <topology_filename> --trajectory <trajectory_url_or_file>

Examples:

Streaming:

mdadash --topology topology.tpr --trajectory imd://localhost:8889

File based trajectories:

mdadash --topology topology.tpr --trajectory trajectory.xtc

To see a list of all the available options:

mdadash -h

$ mdadash -h
usage: mdadash [-h] --topology TOPOLOGY --trajectory TRAJECTORY [--state-file STATE_FILE] [--clear-alerts]
               [--dashboard-port DASHBOARD_PORT] [--dashboard-host DASHBOARD_HOST] [--log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [-v]

Start the MDA Dashboard server

options:
  -h, --help            show this help message and exit
  --topology TOPOLOGY   Topology filepath (required)
  --trajectory TRAJECTORY
                        Trajectory URL or file (Eg: 'imd://host:port' or trajectory.xtc) (required)
  --state-file STATE_FILE
                        The dashboard state file (default: mdadash.state.json)
  --clear-alerts        Clear alerts if any from dashboard state
  --dashboard-port DASHBOARD_PORT
                        Port to run the dashboard server on (default: 8000)
  --dashboard-host DASHBOARD_HOST
                        Host address to bind dashboard server to (default: 127.0.0.1)
  --log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}
                        Set the logging level (default: INFO)
  -v, --version         Show the dashboard version and exit

Dashboard

The dashboard can be accessed by navigating to http://127.0.0.1:8000 from any browser.

Note: Both the dashboard host and post can be customized using the mdadash command line options.

Development

Developer instructions for this project can be found here.

Copyright

The mdadash source code is hosted at https://github.com/MDAnalysis/mdadash and is available under the MIT License (see the file LICENSE).

Copyright (c) 2026, MDAnalysis

Acknowledgements

Project based on the MDAnalysis Cookiecutter version 0.1. Please cite MDAnalysis when using mdadash in published work.

Project links

Data verified by PyPI on Aug 9, 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:
Newer release available (0.1.0)

2 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for jeremyleung521 from gravatar.com jeremyleung521 Avatar for PardhavMaradani from gravatar.com PardhavMaradani

Credits

Author/Maintainer: Pardhav Maradani

GitHub Statistics

Data verified by PyPI on Aug 9, 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

dev test doc

Tags

streaming monitoring mdanalysis molecular-dynamics-simulations

Classifiers

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

mdadash-0.0.8.tar.gz (13.6 MB view details)

Uploaded Source

Built Distribution

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

mdadash-0.0.8-py3-none-any.whl (540.7 kB view details)

Uploaded Python 3

File details

Details for the file mdadash-0.0.8.tar.gz.

File metadata

  • Download URL: mdadash-0.0.8.tar.gz
  • Upload date:
  • Size: 13.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for mdadash-0.0.8.tar.gz
Algorithm Hash digest
SHA256 4c3ef424190f8e2ffdf41d46feaac0d2e9219bc74fc85c5e49ee7aa9cc086f7a
MD5 1047be61d1c2b5b2523126a1e8a88297
BLAKE2b-256 c3786caea41e29d6871d96ea625d4069c127781ebe982163b2376b9f4b9ad380

See more details on using hashes here.

Provenance

The following attestation bundles were made for mdadash-0.0.8.tar.gz:

Publisher: deploy.yaml on MDAnalysis/mdadash

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

File details

Details for the file mdadash-0.0.8-py3-none-any.whl.

File metadata

  • Download URL: mdadash-0.0.8-py3-none-any.whl
  • Upload date:
  • Size: 540.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for mdadash-0.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 c7f58657c5dd05f0fbec9092476f5d15dc5cca91ab4b778384307759cc39b3b9
MD5 95bff9417adcdde020523d6a847845f1
BLAKE2b-256 6ec785185449e7a2af84a535477bfe1c672cc86a3b0bab76548a8180382b3038

See more details on using hashes here.

Provenance

The following attestation bundles were made for mdadash-0.0.8-py3-none-any.whl:

Publisher: deploy.yaml on MDAnalysis/mdadash

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