Skip to main content

README

MUSCLE3 wrapper for TORAX, with serialized IMAS I/O.

Installation

As a user, simply install TORAX-MUSCLE3 with pip:

pip install torax-muscle3

Quick developer installation guide

git clone git@github.com:iterorganization/TORAX-MUSCLE3.git
cd TORAX-MUSCLE3
python3 -m venv ./venv
. venv/bin/activate
pip install -e .[all]
pytest

Documentation

Documentation is autogenerated from the source using Sphinx. The documentation can be manually generated by installing sphinx and running:

# after installation and with venv activated
make -C docs html

How to use

To add an actor to your MUSCLE3 workflow, add the following to the implementations in your ymmsl file:

implementations:
  torax_actor:
    executable: python
    args: -u -m torax_muscle3.torax_actor

Check the actor specific documentation pages to find the relevant ports, settings, etc.

Metadata

Release files for torax-muscle3 0.1.2

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

Source distribution (sdist)

Source distribution for torax-muscle3 0.1.2
File Size Uploaded
torax_muscle3-0.1.2.tar.gz 3.1 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for torax-muscle3 0.1.2
File Interpreter ABI Platform
torax_muscle3-0.1.2-py3-none-any.whl Python 3 none any Details

Total release size: 6.3 MB

Release files / torax_muscle3-0.1.2.tar.gz

Download URL torax_muscle3-0.1.2.tar.gz
Size 3.1 MB
Tags Source
SHA-256 checksum
How to use checksums
320a822aa08ebadc7803a4be36944701c6176aa879ccb4bfd398bec5779a0db9
BLAKE2b-256 checksum
How to use checksums
793cb07c8e286b8c757687a160ee978d99c260060518faa5a3d947c60f8ff976
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

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 Apr 8, 2026.

Transparency log

Release files / torax_muscle3-0.1.2-py3-none-any.whl

Download URL torax_muscle3-0.1.2-py3-none-any.whl
Size 3.1 MB
Tags Python 3
SHA-256 checksum
How to use checksums
837879cef8b6c7979ff6872164653eaa229817a4837f10d7187ec5726eb76132
BLAKE2b-256 checksum
How to use checksums
a95421b82dca040fd6ae3012044bfd30655ca4782879b2715c7fb22a80d35a9d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

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 Apr 8, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

0.1.2 This release

2 release files

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