yMMSL Python bindings

Welcome to the documentation pages for yMMSL, the YAML version of the Multiscale Modeling and Simulation Language. At the moment, yMMSL is mainly the configuration language for the MUSCLE3 multiscale coupling library.

This library provides Python bindings for yMMSL. With it, you can read and write yMMSL files, and manipulate them using a Python object representation of their contents. This documentation gives an overview of the format, and a description of the Python API.

This documentation describes the latest version of the ymmsl package, which supports yMMSL version 0.2. There is documentation for the old version 0.1 as well, or click the downward arrow in the blue box at the top left, and select release-0.14.0.

Contents:

• Basic usage
  • Installation
  • Reading yMMSL files
  • Writing yMMSL files
• Data model overview
• Describing models
  • Models
  • Supported settings
  • Simulation Components
  • Conduits
  • Nesting models
  • Multiple files and imports
• Describing scenarios
  • Custom implementations
  • Settings
• Describing programs
  • Programs
  • Keeps state for next use
• Describing runs
  • Resources
  • Checkpoints
• Creating yMMSL from Python
• Functionality
  • Format conversion
  • Merging
  • Checking consistency
  • Resolving imports
• Upgrading to v0.2
  • Upgrading yMMSL files
  • Upgrading Python code

API Reference

• API reference
  • Package ymmsl
  • Package ymmsl.v0_2
  • Package ymmsl.v0_1

Indices and tables

• Index

• Module Index

• Search Page