Model:ModelParameterDictionary

Edit Model information

ModelParameterDictionary

Metadata

Summary Contact Technical specs In/Output Process Testing Other Component info 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 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 USA"USA" is not in the list (Afghanistan, Albania, Algeria, Andorra, Angola, Antigua and Barbuda, Argentina, Armenia, Australia, Austria, ...) of allowed values for the "Country" property. 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 When did you indicate the 'code development status'? 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 not possible BMI compliant No but possible WMT component Not yet"Not yet" is not in the list (Yes, In progress, No but possible, No not possible) of allowed values for the "Code CMT compliant or not" property. 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 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 Bedrock Fault Scarp CHILD FractureGridGenerator GOLEM Landlab LinearDiffuser ModelParameterDictionary StreamPowerSmoothThresholdEroder

Download statistics

<pbars ytitle=Downloads Title='Monthly Downloads modelparameterdictionary' xlabels=true size=900x200 ymax=10 grid=true box=true cubic=true plots=open xformat=number connected=true angle=90 legend> ,Total downloads: 30 2008 - Jan,0 Feb,0 Mar,0 Apr,0 May,0 Jun,0 Jul,0 Aug,0 Sep,0 Oct,0 Nov,0 Dec,0 2009 - Jan,0 Feb,0 Mar,0 Apr,0 May,0 Jun,0 Jul,0 Aug,0 Sep,0 Oct,0 Nov,0 Dec,0 2010 - Jan,0 Feb,0 Mar,0 Apr,0 May,0 Jun,0 Jul,0 Aug,0 Sep,0 Oct,0 Nov,0 Dec,0 2011 - Jan,0 Feb,0 Mar,0 Apr,0 May,0 Jun,1 Jul,0 Aug,0 Sep,0 Oct,0 Nov,1 Dec,0 2012 - Jan,3 Feb,4 Mar,0 Apr,0 May,0 Jun,0 Jul,0 Aug,2 Sep,0 Oct,0 Nov,1 Dec,0 2013 - Jan,0 Feb,2 Mar,0 Apr,1 May,0 Jun,0 Jul,1 Aug,0 Sep,0 Oct,1 Nov,4 Dec,1 2014 - Jan,0 Feb,0 Mar,1 Apr,0 May,1 Jun,0 Jul,0 Aug,0 Sep,1 Oct,2 Nov,1 Dec,1 2015 - Jan,0 Feb,1 Mar,0 Apr,0 May,0 Jun,0 Jul,0 </pbars>

References

Add a publication

Source code

Suggested way to reference a version of the model source code following data reference guidelines:

The part "]]" of the query was not understood.</br>Results might not be as expected.

Publication(s)	Model described	Citations

Overview and general

The part "]]" of the query was not understood.</br>Results might not be as expected.

Publication(s)	Model described	Citations

Applications

The part "]]" of the query was not understood.</br>Results might not be as expected.

Publication(s)	Model described	Citations

Related theory and data

The part "]]" of the query was not understood.</br>Results might not be as expected.

Publication(s)	Model described	Citations