Jupyter Notebooks for the ROMS Data Component

This resource includes two Jupyter Notebooks as a quick start tutorial for the ROMS data component of the PyMT modeling framework (https://pymt.readthedocs.io/) developed by Community Surface Dynamics Modeling System (CSDMS https://csdms.colorado.edu/).

bmi_roms package is an implementation of the Basic Model Interface (BMI https://bmi.readthedocs.io/en/latest/) for the ROMS model (https://www.myroms.org/) datasets. This package downloads the datasets and wraps them with BMI for data control and query. This package is not implemented for people to use but is the key element to convert the ROMS model output dataset into a data component for the PyMT modeling framework.

The pymt_roms package is implemented for people to use as a reusable, plug-and-play ROMS data component for the PyMT modeling framework. This package uses the BMI implementation from the bmi_roms package and allows the ROMS datasets to be easily coupled with other datasets or models that expose a BMI.

If there is any question or suggestion about the ROMS data component, please create a github issue at https://github.com/gantian127/bmi_roms/issues

本资源包含两个 Jupyter 笔记本，作为 PyMT 模型框架（https://pymt.readthedocs.io/）中 ROMS 数据组件的快速入门教程，该框架由社区地表动力学建模系统（CSDMS https://csdms.colorado.edu/）开发。bmi_roms 软件包实现了基本模型接口（BMI https://bmi.readthedocs.io/en/latest/）针对 ROMS 模型（https://www.myroms.org/）数据集的版本，该软件包负责下载数据集并将其封装以 BMI 形式，以便于数据控制和查询。本软件包并非供用户直接使用，而是将 ROMS 模型输出数据集转化为 PyMT 模型框架的数据组件的关键要素。pymt_roms 软件包则面向用户实现，作为可重用、即插即用的 ROMS 数据组件，适用于 PyMT 模型框架。该软件包利用 bmi_roms 软件包中的 BMI 实现方式，使得 ROMS 数据集能够轻松与其他公开 BMI 的数据集或模型耦合。如有关于 ROMS 数据组件的任何疑问或建议，请于 https://github.com/gantian127/bmi_roms/issues 创建 GitHub 问题。