Workbench: Difference between revisions

From CSDMS
(Remove table with product logos)
(Use headings for the Workbench elements)
Line 4: Line 4:
developed by CSDMS for building, interfacing, and coupling models.
developed by CSDMS for building, interfacing, and coupling models.
Each element of the CSDMS Workbench is developed as open source software and released to the community under the MIT License.
Each element of the CSDMS Workbench is developed as open source software and released to the community under the MIT License.
The CSDMS Workbench consists of five core elements:
The CSDMS Workbench consists of the five core elements listed below.


# [[BMI_Description|Basic Model Interface (BMI)]]
== Basic Model Interface ==
# [[CSDMS_Standard_Names|Standard Names (CSN)]]
The [[BMI_Description|Basic Model Interface]] (BMI) is a set of functions that standardizes how numerical models can be queried, modified, and run. A model with a BMI exposes the same set of functions, no matter which language the model is written in. While a BMI can be specified for any language, CSDMS currently supports C, C++, Fortran, and Python.
# [[Babelizer]]
# [[PyMT|Python Modeling Toolkit (PyMT)]]
# [[Landlab]]
 
 
The ''Basic Model Interface'' (BMI) is a set of functions that standardizes how numerical models can be queried, modified, and run. A model with a BMI exposes the same set of functions, no matter which language the model is written in. While a BMI can be specified for any language, CSDMS currently supports C, C++, Fortran, and Python.
[[https://bmi.readthedocs.io documentation], [https://github.com/csdms/bmi source repository]]
[[https://bmi.readthedocs.io documentation], [https://github.com/csdms/bmi source repository]]


''CSDMS Standard Names'' (CSN) provide a comprehensive set of naming rules and patterns that are not specific to any particular modeling domain. CSN were designed with features such as parsability and natural alphabetical grouping. CSN consist of an object part and a quantity/attribute part; the quantity part may also have an operation prefix with multiple operations.
== CSDMS Standard Names ==
[[CSDMS_Standard_Names|Standard Names]] (CSN) provide a comprehensive set of naming rules and patterns that are not specific to any particular modeling domain. CSN were designed with features such as parsability and natural alphabetical grouping. CSN consist of an object part and a quantity/attribute part; the quantity part may also have an operation prefix with multiple operations.
[[https://standard-names.readthedocs.io documentation], [https://github.com/csdms/standard_names source repository]]
[[https://standard-names.readthedocs.io documentation], [https://github.com/csdms/standard_names source repository]]


The ''Babelizer'' is a utility for wrapping models that expose a BMI so they can be imported as Python packages. Within Python, these models, regardless of their core language, appear as classes. Users are then able to run models interactively through the Python command line or Jupyter Notebook, and programmatically through Python.
== Babelizer ==
The [[Babelizer]] is a utility for wrapping models that expose a BMI so they can be imported as Python packages. Within Python, these models, regardless of their core language, appear as classes. Users are then able to run models interactively through the Python command line or Jupyter Notebook, and programmatically through Python.
[[https://babelizer.readthedocs.io documentation], [https://github.com/csdms/babelizer source repository]]
[[https://babelizer.readthedocs.io documentation], [https://github.com/csdms/babelizer source repository]]


The ''Python Modeling Toolkit'' (PyMT) provides the tools needed for coupling models that expose a BMI. PyMT provides utilities for coupling models of disparate time and space scales, a grid interpolator, unit conversions, a sample collection of earth surface processes models, and an extensible plug-in framework for adding new models.
== Python Modeling Toolkit ==
The [[PyMT|Python Modeling Toolkit]] (PyMT) provides the tools needed for coupling models that expose a BMI. PyMT provides utilities for coupling models of disparate time and space scales, a grid interpolator, unit conversions, a sample collection of earth surface processes models, and an extensible plug-in framework for adding new models.
[[https://pymt.readthedocs.io documentation], [https://github.com/csdms/pymt source repository]]
[[https://pymt.readthedocs.io documentation], [https://github.com/csdms/pymt source repository]]


''Landlab'' is a Python library that allows users to easily build unique earth surface processes models to address specific hypotheses. The Landlab library contains gridding engines for building regular and irregular grids, process components that act on grid variables, tools for storing and sharing data among the grid and components, and plotting and analysis tools.  
== Landlab ==
[[Landlab]] is a Python library that allows users to easily build unique earth surface processes models to address specific hypotheses. The Landlab library contains gridding engines for building regular and irregular grids, process components that act on grid variables, tools for storing and sharing data among the grid and components, and plotting and analysis tools.  
[[https://landlab.readthedocs.io documentation], [https://github.com/landlab/landlab source repository]]
[[https://landlab.readthedocs.io documentation], [https://github.com/landlab/landlab source repository]]



Revision as of 12:14, 10 March 2021

The CSDMS Workbench

The CSDMS Workbench is the integrated system of software tools, technologies, and standards developed by CSDMS for building, interfacing, and coupling models. Each element of the CSDMS Workbench is developed as open source software and released to the community under the MIT License. The CSDMS Workbench consists of the five core elements listed below.

Basic Model Interface

The Basic Model Interface (BMI) is a set of functions that standardizes how numerical models can be queried, modified, and run. A model with a BMI exposes the same set of functions, no matter which language the model is written in. While a BMI can be specified for any language, CSDMS currently supports C, C++, Fortran, and Python. [documentation, source repository]

CSDMS Standard Names

Standard Names (CSN) provide a comprehensive set of naming rules and patterns that are not specific to any particular modeling domain. CSN were designed with features such as parsability and natural alphabetical grouping. CSN consist of an object part and a quantity/attribute part; the quantity part may also have an operation prefix with multiple operations. [documentation, source repository]

Babelizer

The Babelizer is a utility for wrapping models that expose a BMI so they can be imported as Python packages. Within Python, these models, regardless of their core language, appear as classes. Users are then able to run models interactively through the Python command line or Jupyter Notebook, and programmatically through Python. [documentation, source repository]

Python Modeling Toolkit

The Python Modeling Toolkit (PyMT) provides the tools needed for coupling models that expose a BMI. PyMT provides utilities for coupling models of disparate time and space scales, a grid interpolator, unit conversions, a sample collection of earth surface processes models, and an extensible plug-in framework for adding new models. [documentation, source repository]

Landlab

Landlab is a Python library that allows users to easily build unique earth surface processes models to address specific hypotheses. The Landlab library contains gridding engines for building regular and irregular grids, process components that act on grid variables, tools for storing and sharing data among the grid and components, and plotting and analysis tools. [documentation, source repository]


To learn more about the CSDMS Workbench, visit the individual product pages linked above, or reach out to us through the CSDMS Help Desk, or email us at csdms@colorado.edu.