Skip to main content

ReaxKit

ReaxKit is a modular, extensible Python toolkit for pre‑processing, post‑processing, and analysis of ReaxFF molecular dynamics simulations. It provides a clean separation between file parsing, analysis routines, and reproducible workflows, with Python APIs, a CLI interface, and a Dash-based GUI.

ReaxKit is designed for researchers who want a transparent, scriptable bridge between raw ReaxFF data and quantitative, publication‑ready results.


Key Capabilities

Engine

  • Shared engine abstractions for consistent parsing and generating input/output files across 3 different ReaxFF simulation engines, namely ams, lammps, reaxff
  • Example IO and generator modules under the reaxff engine:
    • ReaxFF input and output files such as xmolout, fort.7, fort.13, molfra, and more
    • Input generators for control, geo, eregime, tregime, and related files

Analysis

  • Engine-agnostic analyzers built on ReaxKit's domain data models
  • Analyzer tasks organized around separated request, result, and task objects
  • Analysis components separated from engine IO so the same computations can be reused across scripts, workflows, web UI, and presentation modules

Workflows

  • Reproducible workflows organized by data handling, file tools, meta orchestration, presentation, and study design
  • Automation paths for common ReaxFF pre-processing, analysis, post-processing, and presentation tasks

Web UI

  • Dash-based interface components for interactive ReaxFF data inspection
  • Backend, UI, and presentation layers for browser-driven workflows

Presentation

  • Publication-ready plotting utilities:
    • 2D plots, dual-axis plots, tornado plots, 3D scatter, and heatmaps
  • Video generators

Utilities

  • Shared data, media, and numerical utilities
  • Common infrastructure used by analysis, workflows, web UI, and presentation modules

See the full documentation (API reference, tutorials, examples) on ReaxKit Site.


Project Layout

src/reaxkit/
├── analysis/        # Engine-agnostic analysis tasks
├── cli/             # Command-line entry points
├── core/            # Registries and shared core infrastructure
├── data/            # Packaged reference data and resources
├── domain/          # Central data models, requests, and results
├── engine/          # IO handlers and input generators
├── help/            # Introspection and help system
├── presentation/    # Plotting, active-site views, and media presentation
├── utils/           # Shared data, media, and numerical utilities
├── webui/           # Dash/web interface backend, UI, and presentation layers
└── workflows/       # Workflow orchestration and automation

Testing

Run unit tests with:

pytest -s tests/

to test the package and get the timing for their execution.


Citation

If you use ReaxKit in your work, please cite:

Dinani, A. M., van Duin, A., Shin, Y. K., & Sepehrinezhad, A. (2025).
ReaxKit: A modular Python toolkit for ReaxFF simulation analysis.
Zenodo. https://doi.org/10.5281/zenodo.18485384

Source code: https://github.com/ali-m-dinani/reaxkit

Future Directions

  • Implement machine learning-based surrogate models for rapid property prediction and active-site identification.
  • Develop a plugin system for user-contributed analysis routines and visualization components.
  • Integrate with Jupyter notebooks for interactive analysis and visualization.

If you have any feature request, you can submit it through the ReaxKit's GitHub page, or directly sending an email to Dinani@psu.edu.


Additional resources:

  • AUTHORS.md — Full credits and acknowledgments.
  • LICENSE — Full license terms under the MIT License

Release files for reaxkit 3.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for reaxkit 3.0.0
File Size Uploaded
reaxkit-3.0.0.tar.gz 844.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for reaxkit 3.0.0
File Interpreter ABI Platform
reaxkit-3.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 1.9 MB

Release files / reaxkit-3.0.0.tar.gz

Download URL reaxkit-3.0.0.tar.gz
Size 844.1 kB
Tags Source
SHA-256 checksum
How to use checksums
ccd13fd7c6109cb574cc14b00125f9601dbe2b673974683e251946e6b50f57bc
BLAKE2b-256 checksum
How to use checksums
f7d1ce0535bfbc56879c591558eb3a50de56c36dc17e94deed5dbde0991614a5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 11, 2026.

Transparency log

Release files / reaxkit-3.0.0-py3-none-any.whl

Download URL reaxkit-3.0.0-py3-none-any.whl
Size 1.1 MB
Tags Python 3
SHA-256 checksum
How to use checksums
df2bb81838afa3fd9a26be36d61a5eac75bb30092ed067b605bdf068e01302ee
BLAKE2b-256 checksum
How to use checksums
95c6e2a27a09e306ceb33e021d40c9a6998b65628d53725192927ec810ed09dd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 11, 2026.

Transparency log

Release history Release notifications | RSS feed

3.1.0

2 release files

3.0.3

2 release files

This release

3.0.0 This release

2 release files

2.0.0

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page