Skip to main content

TORAX IMAS MUSCLE3 wrapper

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

torax_muscle3-0.1.2.tar.gz (3.1 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

torax_muscle3-0.1.2-py3-none-any.whl (3.1 MB view details)

Uploaded Python 3

File details

Details for the file torax_muscle3-0.1.2.tar.gz.

File metadata

  • Download URL: torax_muscle3-0.1.2.tar.gz
  • Upload date:
  • Size: 3.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for torax_muscle3-0.1.2.tar.gz
Algorithm Hash digest
SHA256 320a822aa08ebadc7803a4be36944701c6176aa879ccb4bfd398bec5779a0db9
MD5 57761c1adf5b72638e59b82007a93c30
BLAKE2b-256 793cb07c8e286b8c757687a160ee978d99c260060518faa5a3d947c60f8ff976

See more details on using hashes here.

Provenance

The following attestation bundles were made for torax_muscle3-0.1.2.tar.gz:

Publisher: publish.yml on iterorganization/TORAX-MUSCLE3

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file torax_muscle3-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: torax_muscle3-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 3.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for torax_muscle3-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 837879cef8b6c7979ff6872164653eaa229817a4837f10d7187ec5726eb76132
MD5 ddaaadea258025f017b9095316b3c6cc
BLAKE2b-256 a95421b82dca040fd6ae3012044bfd30655ca4782879b2715c7fb22a80d35a9d

See more details on using hashes here.

Provenance

The following attestation bundles were made for torax_muscle3-0.1.2-py3-none-any.whl:

Publisher: publish.yml on iterorganization/TORAX-MUSCLE3

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page