Skip to content

csdms/pymt

Folders and files

NameName
Last commit message
Last commit date

Latest commit

c0544b6 · Oct 22, 2024
Oct 11, 2024
Mar 17, 2021
Oct 13, 2022
Feb 16, 2023
Oct 11, 2024
Feb 3, 2023
Oct 11, 2024
Feb 3, 2023
Oct 11, 2024
Oct 27, 2017
Feb 19, 2019
Jan 13, 2019
Oct 22, 2024
Oct 13, 2022
Oct 11, 2024
Aug 1, 2021
Oct 13, 2022
May 13, 2022
Oct 13, 2022
Oct 13, 2022
Oct 22, 2024
Mar 18, 2021
Oct 4, 2021
May 12, 2022
Oct 11, 2024
Apr 8, 2020
Oct 22, 2020
Mar 18, 2021
Sep 27, 2021
Oct 11, 2024
May 13, 2022
Feb 16, 2023

Repository files navigation

PYMT

The Python Modeling Toolkit (pymt)

Build Status License Code Style Documentation Status Coverage Status Conda Version Conda Downloads Binder

Quick links:

pymt is an Open Source Python package, developed by the Community Surface Dynamics Modeling System (CSDMS), that provides the necessary tools used for the coupling of models that expose the Basic Model Interface (BMI). It contains:

  • Tools necessary for coupling models of disparate time and space scales (including grid mappers)
  • Time-steppers that coordinate the sequencing of coupled models
  • Exchange of data between BMI-enabled models
  • Wrappers that automatically load BMI-enabled models into the PyMT framework
  • Utilities that support open-source interfaces (UGRID, SGRID, CSDMS Standard Names, etc.)
  • A collection of community-submitted models, written in a variety of programming languages, from a variety of process domains - but all usable from within the Python programming language
  • A plug-in framework for adding additional BMI-enabled models to the framework

What does it look like? Here is an example of a simple pymt program that couples a Waves model with a Coastline Evolution model.

from pymt.models import Cem, Waves

waves = Waves()
cem = Cem()

waves.initialize(*waves.setup())
cem.initialize(*cem.setup())

for time in range(1000):
    waves.update()
    angle = waves.get_value("wave_angle")
    cem.set_value("wave_angle", angle)
    cem.update()

pymt is an element of the CSDMS Workbench, an integrated system of software tools, technologies, and standards for building and coupling models.

This work is supported by the National Science Foundation under Grant No. 1831623, Community Facility Support: The Community Surface Dynamics Modeling System (CSDMS).

About

A Python toolkit for running and coupling Earth surface models

Topics

Resources

License

Citation

Stars

Watchers

Forks