# model_metadata
![[Python][pypi-link]][python-badge]
![[Build Status][build-link]][build-badge]
![[PyPI][pypi-link]][pypi-badge]
![[Build Status][anaconda-link]][anaconda-badge]
[anaconda-badge]: https://anaconda.org/conda-forge/model_metadata/badges/version.svg
[anaconda-link]: https://anaconda.org/conda-forge/model_metadata
[build-badge]: https://github.com/csdms/model_metadata/actions/workflows/test.yml/badge.svg
[build-link]: https://github.com/csdms/model_metadata/actions/workflows/test.yml
[pypi-badge]: https://badge.fury.io/py/model_metadata.svg
[pypi-link]: https://pypi.org/project/model_metadata/
[python-badge]: https://img.shields.io/pypi/pyversions/model_metadata.svg
Tools for working with CSDMS Model Metadata
The CSDMS Model Metadata provides a detailed and formalized description
of a model. This includes information about:
- Identifying information about the model. For example, model
author(s), citations for the model, URL to the source code, etc.
- A description of the model API, if it has been wrapped with a Basic
Model Interface. This includes, for instance, how to build the model,
depending on the language, what include statements are needed, etc.
- A description of input file parameters. This includes default values,
acceptable parameter ranges, units, etc.
- Template input files. These are a set of input files that contain
special markup where parameters from the metadata parameter
description can be placed.
- A description of how to run the model from the command line.
The CSDMS Model Metadata is extensible and not yet complete. New
metadata will most certainly be added in the future. We believe the
current specification provides a minimum amount of information needed to
describe a model to be either run as a standalone model or, possibly, to
couple with another model.
Whereas the BMI answers run-time queries of a model (e.g. the current
time of a model simulation, the value of a particular output variable),
the CSDMS Model Metadata provides a static description of a model. The
Model Metadata, along with a BMI implementation, allows a model to
automatically be incorporated as a component in the CSDMS PyMT.
## Info section
Identifying information about the model.
```yaml
info:
summary:
Sedflux3D is a basin filling stratigraphic model. Sedflux3d simulates
long-term marine sediment transport and accumulation into a
three-dimensional basin over time scales of tens of thousands of years. It
simulates the dynamics of strata formation of continental margins based on
distribution of river plumes and tectonics.
url: http://csdms.colorado.edu/wiki/Model_help:Sedflux
author: Eric Hutton
email: eric.hutton@colorado.edu
version: "2.1"
license: MIT
doi: "10.1594/IEDA/100161"
cite_as: |
@article{hutton2008sedflux,
title={Sedflux 2.0: An advanced process-response model that generates three-dimensional stratigraphy},
author={Hutton, Eric WH and Syvitski, James PM},
journal={Computers \& Geosciences},
volume={34},
number={10},
pages={1319--1337},
year={2008},
publisher={Pergamon}
}
```
## API Section
A description of the model API.
```yaml
api:
name: Sedflux3D
language: c
register: register_bmi_sedflux3d
includes:
- "#include <sedflux3d/bmi_sedflux3d.h>"
cflags:
pkgconfig: sedflux3d
libs:
pkgconfig: sedflux3d
```
## Parameters Section
A description of the parameters in the input files.
```yaml
parameters:
slope_gradient:
description: Gradient of slope
value:
default: 0.01
range:
max: 0.1
min: 0.0
type: float
units: m
shelf_width:
description: Width of shelf
value:
default: 100000.0
range:
max: 1000000.0
min: 1000.0
type: float
units: m
```
## Run Section
How the model is to be run.
```yaml
run:
config_file: sedflux_3d_init.kvf
```
# Model Metadata Tools
The CSDMS *model_metadata* Python package provides tools for working
with CSDMS Model Metadata. Contained within this package are tools for:
- Reading and parsing model metadata that follow the CSDMS Model
Metadata Standards.
- Setting up model simulations either programmatically or through a
commandline interface. Although model metadata may describe models
with different interfaces, the model metadata tools provides a common
interface for staging simulations.
- Validing input parameter units, ranges, and type checking. If, for
instance, a user provides an input value that is out of range, an
error can be issued.
- Running simulations, which have already been staged, through a common
interface.
These tools are currently used by:
- The Web Modeling Tool server to validate input parameters and stage
model simulations.
- The CSDMS Execution Server and PyMT for running BMI-enabled models.
- Commandline utilities for quering model metadata, and staging model
simulations.
Raw data
{
"_id": null,
"home_page": "",
"name": "model-metadata",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Eric Hutton <huttone@colorado.edu>",
"keywords": "BMI,Basic Model Interface",
"author": "",
"author_email": "Eric Hutton <huttone@colorado.edu>",
"download_url": "https://files.pythonhosted.org/packages/a7/70/6f60b1d6e6d6b11978bd7fd853955be9c682611e3848df88abe8e1842728/model_metadata-0.8.1.tar.gz",
"platform": null,
"description": "# model_metadata\n\n![[Python][pypi-link]][python-badge]\n![[Build Status][build-link]][build-badge]\n![[PyPI][pypi-link]][pypi-badge]\n![[Build Status][anaconda-link]][anaconda-badge]\n\n[anaconda-badge]: https://anaconda.org/conda-forge/model_metadata/badges/version.svg\n[anaconda-link]: https://anaconda.org/conda-forge/model_metadata\n[build-badge]: https://github.com/csdms/model_metadata/actions/workflows/test.yml/badge.svg\n[build-link]: https://github.com/csdms/model_metadata/actions/workflows/test.yml\n[pypi-badge]: https://badge.fury.io/py/model_metadata.svg\n[pypi-link]: https://pypi.org/project/model_metadata/\n[python-badge]: https://img.shields.io/pypi/pyversions/model_metadata.svg\n\nTools for working with CSDMS Model Metadata\n\nThe CSDMS Model Metadata provides a detailed and formalized description\nof a model. This includes information about:\n\n- Identifying information about the model. For example, model\n author(s), citations for the model, URL to the source code, etc.\n- A description of the model API, if it has been wrapped with a Basic\n Model Interface. This includes, for instance, how to build the model,\n depending on the language, what include statements are needed, etc.\n- A description of input file parameters. This includes default values,\n acceptable parameter ranges, units, etc.\n- Template input files. These are a set of input files that contain\n special markup where parameters from the metadata parameter\n description can be placed.\n- A description of how to run the model from the command line.\n\nThe CSDMS Model Metadata is extensible and not yet complete. New\nmetadata will most certainly be added in the future. We believe the\ncurrent specification provides a minimum amount of information needed to\ndescribe a model to be either run as a standalone model or, possibly, to\ncouple with another model.\n\nWhereas the BMI answers run-time queries of a model (e.g.\u00a0the current\ntime of a model simulation, the value of a particular output variable),\nthe CSDMS Model Metadata provides a static description of a model. The\nModel Metadata, along with a BMI implementation, allows a model to\nautomatically be incorporated as a component in the CSDMS PyMT.\n\n## Info section\n\nIdentifying information about the model.\n\n```yaml\ninfo:\n summary:\n Sedflux3D is a basin filling stratigraphic model. Sedflux3d simulates\n long-term marine sediment transport and accumulation into a\n three-dimensional basin over time scales of tens of thousands of years. It\n simulates the dynamics of strata formation of continental margins based on\n distribution of river plumes and tectonics.\n url: http://csdms.colorado.edu/wiki/Model_help:Sedflux\n author: Eric Hutton\n email: eric.hutton@colorado.edu\n version: \"2.1\"\n license: MIT\n doi: \"10.1594/IEDA/100161\"\n cite_as: |\n @article{hutton2008sedflux,\n title={Sedflux 2.0: An advanced process-response model that generates three-dimensional stratigraphy},\n author={Hutton, Eric WH and Syvitski, James PM},\n journal={Computers \\& Geosciences},\n volume={34},\n number={10},\n pages={1319--1337},\n year={2008},\n publisher={Pergamon}\n }\n```\n\n## API Section\n\nA description of the model API.\n\n```yaml\napi:\n name: Sedflux3D\n language: c\n register: register_bmi_sedflux3d\n includes:\n - \"#include <sedflux3d/bmi_sedflux3d.h>\"\n cflags:\n pkgconfig: sedflux3d\n libs:\n pkgconfig: sedflux3d\n```\n\n## Parameters Section\n\nA description of the parameters in the input files.\n\n```yaml\nparameters:\n slope_gradient:\n description: Gradient of slope\n value:\n default: 0.01\n range:\n max: 0.1\n min: 0.0\n type: float\n units: m\n\n shelf_width:\n description: Width of shelf\n value:\n default: 100000.0\n range:\n max: 1000000.0\n min: 1000.0\n type: float\n units: m\n```\n\n## Run Section\n\nHow the model is to be run.\n\n```yaml\nrun:\n config_file: sedflux_3d_init.kvf\n```\n\n# Model Metadata Tools\n\nThe CSDMS *model_metadata* Python package provides tools for working\nwith CSDMS Model Metadata. Contained within this package are tools for:\n\n- Reading and parsing model metadata that follow the CSDMS Model\n Metadata Standards.\n- Setting up model simulations either programmatically or through a\n commandline interface. Although model metadata may describe models\n with different interfaces, the model metadata tools provides a common\n interface for staging simulations.\n- Validing input parameter units, ranges, and type checking. If, for\n instance, a user provides an input value that is out of range, an\n error can be issued.\n- Running simulations, which have already been staged, through a common\n interface.\n\nThese tools are currently used by:\n\n- The Web Modeling Tool server to validate input parameters and stage\n model simulations.\n- The CSDMS Execution Server and PyMT for running BMI-enabled models.\n- Commandline utilities for quering model metadata, and staging model\n simulations.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Model metadata",
"version": "0.8.1",
"project_urls": {
"documentation": "https://github.com/csdms/model_metadata",
"homepage": "https://github.com/csdms/model_metadata",
"repository": "https://github.com/csdms/model_metadata"
},
"split_keywords": [
"bmi",
"basic model interface"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a7706f60b1d6e6d6b11978bd7fd853955be9c682611e3848df88abe8e1842728",
"md5": "654d76c63f02d7f01791876c382e3df7",
"sha256": "27511d34b0534b6ed8f860aecc264d75310cfe3d1a00f1f4ab3908330f64a505"
},
"downloads": -1,
"filename": "model_metadata-0.8.1.tar.gz",
"has_sig": false,
"md5_digest": "654d76c63f02d7f01791876c382e3df7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 19267,
"upload_time": "2024-01-31T07:00:09",
"upload_time_iso_8601": "2024-01-31T07:00:09.162982Z",
"url": "https://files.pythonhosted.org/packages/a7/70/6f60b1d6e6d6b11978bd7fd853955be9c682611e3848df88abe8e1842728/model_metadata-0.8.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-31 07:00:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "csdms",
"github_project": "model_metadata",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "importlib_resources",
"specs": []
},
{
"name": "jinja2",
"specs": []
},
{
"name": "packaging",
"specs": []
},
{
"name": "pyyaml",
"specs": []
}
],
"lcname": "model-metadata"
}
JSON
