mime-engine 0.1.0

MIcrorobotics Multiphysics Engine — domain-specific physics for microrobot simulation

MIME

MIcrorobotics Multiphysics Engine.

📖 Documentation: https://microrobotica.org/mime/ 🧩 Part of the Microrobotics Simulation Framework (MADDENING · MIME · MICROROBOTICA).

What is MIME?

MIME is a domain-specific physics engine for microrobot simulation, built on the MADDENING framework. It provides microrobotics-specific node classes, a structured asset schema, control abstractions, uncertainty models, and a benchmark suite (B0–B5).

MIME sits at Layer 2 of an open-source stack: MADDENING (physics framework) → MIME (microrobotics engine) → MICROROBOTICA (simulator + registry).

Intended Use and Disclaimers

MIME is research software. It is not a medical device as defined by EU MDR (EU 2017/745) or US FDA regulations. It has no medical purpose. It is not intended for clinical use, clinical decision-making, or patient diagnosis. It has not been CE-marked, cleared, or approved by any regulatory body.

When used as a component within regulated medical software, MIME is classified as SOUP (Software of Unknown Provenance) under IEC 62304. The device manufacturer is responsible for assessing MIME's suitability and performing all required verification and validation. See Regulatory Documentation for details.

Quick Start

# Install MIME from PyPI (pulls maddening as a dependency)
pip install mime-engine

# Or, for GPU acceleration (CUDA 12):
pip install "mime-engine" "jax[cuda12]"

Then in Python:

import mime          # public API: import path is still `mime`
from mime.nodes.environment.external_magnetic_field import ExternalMagneticFieldNode

Full walkthroughs (installation, quickstart, library reference): https://microrobotica.org/mime/

From source (development)

git clone https://github.com/Microrobotics-Simulation-Framework/MIME
cd MIME
pip install -e ".[dev]"
PYTEST_DISABLE_PLUGIN_AUTOLOAD=1 python -m pytest tests/ -v

Documentation

Document	Description
Architecture Plan	System architecture and design decisions
Node Taxonomy	Scientific rationale for physics node categories
Documentation Architecture	Documentation standards and compliance
Algorithm Guide	Mathematical docs per node
Validation	V&V evidence, SOUP package, anomaly registry
Regulatory	Intended use, downstream integration
Contributing	Development setup, conventions
CHANGELOG	Version history

Citation

If you use MIME in academic work, please cite:

@software{mime,
  title = {MIME: MIcrorobotics Multiphysics Engine},
  version = {0.1.0},
  license = {LGPL-3.0-or-later},
  url = {https://github.com/Microrobotics-Simulation-Framework/MIME}
}

License

LGPL-3.0-or-later. See LICENSE.