pymt

A Python toolkit for running and coupling Earth surface models.
https://github.com/csdms/pymt

Category: Climate Change
Sub Category: Earth and Climate Modeling

Keywords

bmi csdms pymt python

Keywords from Contributors

geoscience testing-tools earth-system-model hydrology scripting permafrost geostatistics groundwater modflow open-science

Last synced: about 18 hours ago
JSON representation

Repository metadata

A Python toolkit for running and coupling Earth surface models

• Host: GitHub
• URL: https://github.com/csdms/pymt
• Owner: csdms
• License: mit
• Created: 2014-03-06T18:46:48.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2024-10-22T17:32:15.000Z (6 months ago)
• Last Synced: 2025-04-20T06:35:03.987Z (7 days ago)
• Topics: bmi, csdms, pymt, python
• Language: Jupyter Notebook
• Homepage: https://pymt.readthedocs.io
• Size: 7.72 MB
• Stars: 54
• Watchers: 6
• Forks: 21
• Open Issues: 20
• Releases: 4
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE.rst
  • Citation: CITATION.cff
  • Authors: AUTHORS.rst

README.rst

          |PYMT|

The Python Modeling Toolkit (pymt)
==================================

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

Quick links:

* `User documentation `_
* `Installation instructions `_
* `List of available models `_

*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.

.. code-block:: python

    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)*.


.. _CSDMS Workbench: https://csdms.colorado.edu/wiki/Workbench
.. _1831623: https://nsf.gov/awardsearch/showAward?AWD_ID=1831623

.. |PYMT| image:: https://github.com/csdms/pymt/raw/master/docs/_static/pymt-logo-header-text.png
   :target: https://pymt.readthedocs.org/
.. |Build Status| image:: https://github.com/csdms/pymt/actions/workflows/test.yml/badge.svg
   :target: https://github.com/csdms/pymt/actions/workflows/test.yml
.. |License| image:: https://img.shields.io/badge/License-MIT-yellow.svg
   :target: https://opensource.org/licenses/MIT
.. |Code Style| image:: https://img.shields.io/badge/code%20style-black-000000.svg
   :target: https://github.com/csdms/pymt/actions/workflows/black.yml
.. |Documentation Status| image:: https://readthedocs.org/projects/pymt/badge/?version=latest
   :target: https://pymt.readthedocs.io/en/latest/?badge=latest
.. |Coverage Status| image:: https://coveralls.io/repos/github/csdms/pymt/badge.svg?branch=master
   :target: https://coveralls.io/github/csdms/pymt?branch=master
.. |Conda Version| image:: https://anaconda.org/conda-forge/pymt/badges/version.svg
   :target: https://anaconda.org/conda-forge/pymt
.. |Conda Downloads| image:: https://anaconda.org/conda-forge/pymt/badges/downloads.svg
   :target: https://anaconda.org/conda-forge/pymt
.. |Binder| image:: https://static.mybinder.org/badge_logo.svg
   :target: https://static.mybinder.org/badge_logo.svg

        

Citation (CITATION.cff)

# YAML 1.2
---
authors: 
  -
    family-names: Hutton
    given-names: Eric
    orcid: "https://orcid.org/0000-0002-5864-6459"
  -
    family-names: Piper
    given-names: Mark
    orcid: "https://orcid.org/0000-0001-6418-277X"
  -
    family-names: Drost
    given-names: Niels
    orcid: "https://orcid.org/0000-0001-9795-7981"
  -
    family-names: Gan
    given-names: Tian
    orcid: "https://orcid.org/0000-0003-3624-6910"
  -
    family-names: Kettner
    given-names: Albert
    orcid: "https://orcid.org/0000-0002-7191-6521"
  -
    family-names: Overeem
    given-names: Irina
    orcid: "https://orcid.org/0000-0002-8422-580X"
  -
    family-names: Stewart
    given-names: Scott
  -
    family-names: Wang
    given-names: Kang
    orcid: "https://orcid.org/0000-0003-3416-572X"
cff-version: "1.1.0"
date-released: 2021-03-18
doi: "10.5281/zenodo.4985222"
license: MIT
message: "If you use this software, please cite it using these metadata."
title: "The Python Modeling Toolkit (PyMT)"
version: "1.3.1"
...

---

Owner metadata

• Name: Community Surface Dynamics Modeling System
• Login: csdms
• Email: [email protected]
• Kind: organization
• Description: Cyberinfrastructure for the quantitative modeling of earth and planetary surface processes
• Website: http://csdms.colorado.edu
• Location:
• Twitter: csdms
• Company:
• Icon url: https://avatars.githubusercontent.com/u/6618239?v=4
• Repositories: 65
• Last ynced at: 2023-03-22T14:26:30.253Z
• Profile URL: https://github.com/csdms

---

GitHub Events

Total

• Issues event: 1
• Watch event: 3
• Issue comment event: 3
• Push event: 4
• Pull request event: 1
• Fork event: 1
• Create event: 1

Last Year

• Issues event: 1
• Watch event: 3
• Issue comment event: 3
• Push event: 4
• Pull request event: 1
• Fork event: 1
• Create event: 1

---

Committers metadata

Last synced: 5 days ago

Name	Email	Commits
mcflugen	m****n@g****m	801
Mark Piper	m****r@c****u	150
huttone	h****e@c****a	144
mcflugen	h****e@c****u	62
gantian127	j****7@f****m	21
Albert	k****r	17
Scott	s****s@n****g	9
Mike Taves	m****s@g****m	5
Niels Drost	n****t@e****l	1

Committer domains:

• colorado.edu: 2
• esciencecenter.nl: 1
• nsidc.org: 1
• foxmail.com: 1

---

Issue and Pull Request metadata

Last synced: 2 days ago

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/csdms/pymt

---

---

---

Package metadata

• Total packages: 3
• Total downloads:
  • pypi: 153 last-month
• Total dependent packages: 1 (may contain duplicates)
• Total dependent repositories: 10 (may contain duplicates)
• Total versions: 24
• Total maintainers: 1

---

Dependencies

Score: 11.60723514444097