IMAS tools for MUSCLE3
This repository contains helper actors for working with IMAS data in MUSCLE3. It contains:
- Data source: Load and send timeslices from a DBEntry on the
O_Iport. - Data sink: Save timeslices to a DBEntry on the
F_INITport. - Data sink_source: Load and send a timeslice from a DBEntry on the
O_Fport based on an incoming timeslice on theF_INITport. - Accumulator (buffer) actors: Gather messages on
Sport and send out the combination onO_F. - IMAS-Validator actor: Perform validation checks on data on the
F_INITport, generate reports. - Visualization actor: Visualize incoming IDS data in real-time, receiving timeslices
from a DBEntry on the
Sport and machine description IDSs on theF_INITport.
Documentation
Documentation is autogenerated from the source using Sphinx.
The documentation can be manually generated by installing sphinx and running:
make -C docs html
Installation
Important: IMAS-Core is needed for IMAS-MUSCLE3 to work (which is not publicly available yet). As a user, simply install IMAS-MUSCLE3 with pip:
pip install imas-muscle3
Quick developer installation guide
git clone git@github.com:iterorganization/IMAS-MUSCLE3.git
cd IMAS-MUSCLE3
python3 -m venv ./venv
. venv/bin/activate
pip install -e .[all]
pytest
How to use
To add an actor to your MUSCLE3 workflow, add the following to the implementations in your ymmsl file:
implementations:
*component_name*:
executable: python
args: -u -m imas_muscle3.actors.*component_name*
Check the actor specific documentation pages to find the relevant ports, settings, etc.
1 maintainer
Metadata
1 maintainer
Release files for imas-muscle3 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| imas_muscle3-1.0.0.tar.gz | 4.4 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| imas_muscle3-1.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 4.4 MB
Release files / imas_muscle3-1.0.0.tar.gz
| Download URL | imas_muscle3-1.0.0.tar.gz |
|---|---|
| Size | 4.4 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
cb416e8297d0573c05c2734d063076c441b7da5b25b69520deb19b4340d463cb
|
|
BLAKE2b-256 checksum How to use checksums |
8e951147c790b9beb925a01b038099188b5d579a1b25f6b3412a24ed1e530b29
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
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 Dec 11, 2025.
Transparency logRelease files / imas_muscle3-1.0.0-py3-none-any.whl
| Download URL | imas_muscle3-1.0.0-py3-none-any.whl |
|---|---|
| Size | 36.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9f5f048bfa001b3b80bf4da9fde003b57443487afa97c4ea044d815367d7ae22
|
|
BLAKE2b-256 checksum How to use checksums |
f4120e585725cc556c0806fce3a022350c98a7811d072769fee0809dc3310d05
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
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 Dec 11, 2025.
Transparency log
