BMI Model Metadata

From CSDMS
Revision as of 15:51, 1 April 2013 by Huttone (talk | contribs) (Some model metadata examples YAML files.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Format

Model

%YAML 1.2
--- !<tag:csdms.edu,2012:model>
name: Water_Tank_Model
author: Scott Peckham
version: 0.1
url: "http://csdms.colorado.edu"

input_files: 
  - tank_info.cfg

output_items: 
  - model__time_step
  - tank_cross_section__area
  - tank_cross_section__radius
  - tank_outlet__area
  - tank__outlet__radius
  - tank_outlet_water__flow_speed
  - tank_water__depth
  - tank_water__initial_depth
  - tank_water__volume

input_items: 
  - atmosphere_water__liquid_equivalent_precipitation_rate
  - atmosphere_water__precipitation_duration

Input File

dt         = 1.0
n_steps    = 20
init_depth = 2.0
top_area   = 100.0
out_radius = 1.0
rain_file  = rain_data.txt


%YAML 1.2
--- !<tag:csdms.edu,2012:file>
name: tank_info.cfg
brief: Initialization file for water tank model

parameters:
  time_step:
    brief: Model time step
    units: s
    range: 0., 1.
    default: 1.
  n_steps:
    brief: Number of time steps
    description: Total number of model time steps to take for the simulation
    units: 1
    range: 1, 1000
    default: 20
  init_depth:
    brief: Initial water depth
    units: m
    range: 0., 10.
    default: 2.
  top_area:
    brief: Inlet area
    description: Cross-sectional area of the top of the water tank
    units: m^2
    range: 0., 100.
    default: 1.
  outlet_radius:
    brief: Outlet radius
    units: m
    range: 0., 100.
    default: 1.
  rain_file:
    brief: Name of rainfall file
    description: Name of the file containing rainfall data (if using)
    default: rain_data.txt

template_string: |
  dt         = ${time_step}
  n_steps    = ${n_steps}
  init_depth = ${init_depth}
  top_area   = ${top_area}
  out_radius = ${outlet_radius}
  rain_file  = ${rain_file}