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.