The babelizer is an open source Python utility, developed by the Community Surface Dynamics Modeling System (CSDMS), for wrapping models that expose a Basic Model Interface (BMI) so they can be imported as Python packages.

Supported languages include:

• C

• C++

• Fortran

• Python

Within Python, these models, regardless of their core language, appear as classes that expose a BMI. Users are then able to run models interactively through the Python command line or Jupyter Notebook, and programmatically through Python scripts; they can also use Python-based BMI tools such as the bmi-tester, pymt, and Landlab.

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

User Guide

• The Babelizer: Wrap BMI libraries with Python bindings
  • The Babelizer is part of the CSDMS Workbench
  • Should I use the babelizer?
  • Requirements
  • Installation
  • Input file
  • Use
• Command line interface
  • babelize
• Example: Wrapping a C model
  • Set up a conda environment
  • Build the heat model from source
  • Create a babelizer configuration file
  • Wrap the model with the babelizer
  • Make a pymt component
  • Summary
• Example: Wrapping a Fortran model
  • Set up a conda environment
  • Build the heat model from source
  • Create a babelizer configuration file
  • Wrap the model with the babelizer
  • Make a pymt component
  • Summary
• Glossary

API Reference

If you are looking for information on a specific function, class, or method, this part of the documentation is for you.

• Developer Documentation
  • babelizer package

Additional Information

• Credits
• Changelog
  • Not yet released (2024-04-10)
  • 0.3.9 (2022-03-04)
  • 0.3.8 (2021-05-03)
  • 0.3.7 (2021-03-19)
  • 0.3.6 (2021-01-13)
  • 0.3.5 (2020-12-16)
  • 0.3.4 (2020-12-16)
  • 0.3.3 (2020-10-31)
  • 0.3.2 (2020-10-08)
  • 0.3.1 (2020-09-25)
  • 0.3.0 (2020-09-24)
  • 0.2.0 (2020-09-10)
  • 0.1.3 (2018-10-28)
  • 0.1.2 (2018-06-28)
  • 0.1.1 (2018-04-09)
  • 0.1.0 (2018-04-05)
• Contributing
  • Types of Contributions
  • Get Started!
  • Pull Request Guidelines
  • Deploying
• Code of Conduct
• License
  • The MIT License (MIT)

Help

Adding a BMI to a model and babelizing it can be a daunting task. If you’d like assistance, CSDMS can help. Depending on your need, we can provide advice or consulting services. Feel free to contact us through the CSDMS Help Desk.

Acknowledgments

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

Indices and tables

• Index

• Module Index

• Search Page