Model:ModelParameterDictionary

ModelParameterDictionary

Metadata

Also known as
Model type	Tool
Model part of larger framework
Note on status model
Date note status model

Incorporated models or components:

Spatial dimensions
Spatial extent
Model domain	Terrestrial, Hydrology, Coastal, Marine, Climate
One-line model description	Tool written in Python for reading model input parameters from a simple formatted text file.
Extended model description	The Model Parameter Dictionary is a tool for numerical modelers to easily read and access model parameters from a simple formatted input (text) file. Each parameter has a KEY, which identifies the parameter, and a VALUE, which can be a number or a string. A ModelParameterDictionary object reads model parameters from an input file to a Dictionary, and provides functions for the user to look up particular parameters by key name. The format of the input file looks like: PI: the text "PI" is an example of a KEY 3.1416 AVOGADROS_NUMBER: this is another 6.022e23 FAVORITE_FRUIT: yet another mangoes NUMBER_OF_MANGO_WALKS: this one is an integer 4 ALSO_LIKES_APPLES: this is a boolean true Example code that reads these parameters from a file called "myinputs.txt": my_param_dict = ModelParameterDictionary() my_param_dict.read_from_file( 'myinputs.txt' ) pi = my_param_dict.read_float( 'PI' ) avogado = my_param_dict.read_float( 'AVOGADROS_NUMBER' ) fruit = my_param_dict.read_string( 'FAVORITE_FRUIT' ) nmang = my_param_dict.read_int( 'NUMBER_OF_MANGO_WALKS' ) apples_ok = my_param_dict.read_bool( 'ALSO_LIKES_APPLES' ) As in Python, hash marks (#) denote comments. The rules are that each key must have one and only one parameter value, and each value must appear on a separate line immediately below the key line. Also available are functions to read input parameters from the command line (e.g., read_float_cmdline( 'PI' ) )

Keywords:	input parameters, read in,

Name	Greg Tucker
Type of contact	Model developer
Institute / Organization	CIRES
Postal address 1	Department of Geological Sciences
Postal address 2	University of Colorado, Campus Box 399
Town / City	Boulder
Postal code	80309
State	Colorado
Country	United States
Email address	gtucker@colorado.edu
Phone	+1 303 492 6985
Fax

Supported platforms	Unix, Linux, Mac OS, Windows
Other platform	any platform with Python
Programming language	Python
Other program language
Code optimized	Single Processor
Multiple processors implemented
Nr of distributed processors
Nr of shared processors
Start year development	2010
Does model development still take place?	No
If above answer is no, provide end year model development
Code development status	As is, no updates are provided
When did you indicate the 'code development status'?	2020
Model availability	As code
Source code availability (Or provide future intension)	Through CSDMS repository
Source web address
Source csdms web address	https://github.com/csdms-contrib/modelparameterdictionary
Program license type	GPL v2
Program license type other
Memory requirements	minimal
Typical run time	n/a

Describe input parameters	n/a
Input format
Other input format
Describe output parameters	n/a
Output format
Other output format
Pre-processing software needed?	No
Describe pre-processing software
Post-processing software needed?	No
Describe post-processing software
Visualization software needed?	No
If above answer is yes
Other visualization software

Describe processes represented by the model	n/a
Describe key physical parameters and equations	n/a
Describe length scale and resolution constraints	n/a
Describe time scale and resolution constraints	n/a
Describe any numerical limitations and issues	n/a

Describe available calibration data sets	n/a
Upload calibration data sets if available:
Describe available test data sets	n/a
Upload test data sets if available:
Describe ideal data for testing

Do you have current or future plans for collaborating with other researchers?

Is there a manual available?	No
Upload manual if available:
Model website if any
Model forum / discussion board

Comments

This part will be filled out by CSDMS staff

OpenMI compliant	No but possible
BMI compliant	No but possible
WMT component	No but possible
PyMT component
Is this a data component

DOI model	10.1594/IEDA/100148
For model version	0.1
Year version submitted	2011
Link to file	https://csdms.colorado.edu/pub/models/doi-source-code/modelparameterdictionary-10.1594.IEDA.100148-0.1.tar.gz

Can be coupled with:

Model info

Authors

Greg Tucker

Source code

View in CSDMS GitHub repository

DOI

Download ModelParameterDictionary version: 0.1
Doi: 10.1594/IEDA/100148

Model citations

Nr. of publications:	1
Total citations:	0
h-index:	--"--" is not a number.
m-quotient:	0

QR-code

Link to this page

Other models by author

Introduction

History

References

Nr. of publications:	1
Total citations:	0
h-index:	--"--" is not a number.
m-quotient:	0

Featured publication(s)	Year	Model described	Type of Reference	Citations
Tucker, G.E.; 2011. ModelParameterDictionary, version 0.1.. , , https://csdms.colorado.edu/pub/models/doi-source-code/modelparameterdictionary-10.1594.IEDA.100148-0.1.tar.gz. 10.1594/IEDA/100148 (View/edit entry)	2011	ModelParameterDictionary	Source code ref.	0
See more publications of ModelParameterDictionary

Issues

Help

Input Files

Output Files