Skip to main content

TORAX IMAS MUSCLE3 wrapper

Project description

README

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

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

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

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.0.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.0-py3-none-any.whl (3.1 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for torax_muscle3-0.1.0.tar.gz
Algorithm Hash digest
SHA256 5b8cb2f5c519292d987a665c3898bb224d8c6bfad81aaf8aacd75f6b40a6a1ef
MD5 c6a93665080632cdeb5f74a258e49641
BLAKE2b-256 2b681766d5aaed92d2d9fa699dad90554c4d13e02f1eadf90460f2353bb8df9a

See more details on using hashes here.

Provenance

The following attestation bundles were made for torax_muscle3-0.1.0.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.0-py3-none-any.whl.

File metadata

  • Download URL: torax_muscle3-0.1.0-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.7

File hashes

Hashes for torax_muscle3-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 82746bfeff6da47ecc44f189a23c0d7623f42ec633b09249e25699f4e74f9b40
MD5 0366f51d4ec62962ce16d6887961f3a2
BLAKE2b-256 3dda30ebb4be8b20055e86cd378fccd4c014d2d154f919f78b55c980a117814d

See more details on using hashes here.

Provenance

The following attestation bundles were made for torax_muscle3-0.1.0-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