Model:ROMSBuilder: Difference between revisions

From CSDMS
← Older edit
No edit summary
m Text replacement - "{{End headertab}}" to "{{End headertab}} {{{{PAGENAME}}_autokeywords}}"
 
(10 intermediate revisions by the same user not shown)
Line 5: Line 5:
{{End a table}}
{{End a table}}
{{Model identity2
{{Model identity2
|Categories=Marine
|ModelDomain=Marine
|One-line model description=ROMSBuilder is a CCA-CSDMS Modeling Tool (CMT) compliant component that creates another CMT compliant ROMS component. The new ROMS component is build as per the C-preprocessing options that defines a particular ROMS application.
|One-line model description=ROMSBuilder is a CCA-CSDMS Modeling Tool (CMT) compliant component that creates another CMT compliant ROMS component. The new ROMS component is build as per the C-preprocessing options that defines a particular ROMS application.
|Extended model description=Why ROMSBuilder?
|Extended model description=Why ROMSBuilder?
Line 21: Line 21:
|Postal code=80309
|Postal code=80309
|State=Colorado
|State=Colorado
|Country=USA
|Country=United States
|Email address=jisamma.kallumadikal@colorado.edu
|Email address=jisamma.kallumadikal@colorado.edu
}}
}}
Line 64: Line 64:
{{Additional comments model}}
{{Additional comments model}}
{{CSDMS staff part
{{CSDMS staff part
|OpenMI compliant=No not possible
|OpenMI compliant=No but possible
|IRF interface=No not possible
|IRF interface=No but possible
|CMT component=Not yet
|CMT component=No but possible
|CCA component=Yes
|CCA component=Yes
}}
}}
Line 72: Line 72:
{{End a table}}
{{End a table}}
{{End headertab}}
{{End headertab}}
{{{{PAGENAME}}_autokeywords}}
<!-- PLEASE USE THE "EDIT WITH FORM" BUTTON TO EDIT ABOVE CONTENTS; CONTINUE TO EDIT BELOW THIS LINE -->
<!-- PLEASE USE THE "EDIT WITH FORM" BUTTON TO EDIT ABOVE CONTENTS; CONTINUE TO EDIT BELOW THIS LINE -->
{{#ifexist:Template:{{#sub:{{PAGENAME}}|0|1}}{{#sub:{{lc:{{PAGENAME}}}}|1}} download stats | ==Download statistics==
 
{{{{#sub:{{PAGENAME}}|0|1}}{{#sub:{{lc:{{PAGENAME}}}}|1}} download stats}} | }}


==Introduction==
==Introduction==
Line 80: Line 80:
== History ==
== History ==


== Papers ==
== References  ==
<br>{{AddReferenceUploadButtons}}<br><br>
{{#ifexist:Template:{{PAGENAME}}-citation-indices|{{{{PAGENAME}}-citation-indices}}|}}<br>
{{Include_featured_references_models_cargo}}<br>


== Issues ==
== Issues ==

Latest revision as of 19:15, 16 September 2020



ROMSBuilder


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 Marine
One-line model description ROMSBuilder is a CCA-CSDMS Modeling Tool (CMT) compliant component that creates another CMT compliant ROMS component. The new ROMS component is build as per the C-preprocessing options that defines a particular ROMS application.
Extended model description Why ROMSBuilder?

ROMS extensively uses the C preprocessor (cpp) during compilation to replace code statements, insert files into the code, and select relevant parts of the code depending on its directives. There are numerous cpp options that can be activated in header files for your specific application. The preprocessor reads the source file (*.F) and builds a target file (*.f90) according to activated cpp options. CPP options can be set through the CMT config tab dialogs. ROMSBuilder generates the header file for compiling the new ROMS component from the tab dialog inputs.

Keywords:
Name Jisamma Kallumadikal
Type of contact Model developer
Institute / Organization CSDMS
Postal address 1
Postal address 2
Town / City Boulder
Postal code 80309
State Colorado
Country United States
Email address jisamma.kallumadikal@colorado.edu
Phone
Fax


Supported platforms
Unix, Linux, Mac OS, Windows
Other platform
Programming language

Python

Other program language
Code optimized
Multiple processors implemented
Nr of distributed processors
Nr of shared processors
Start year development 2010
Does model development still take place? Yes
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)
Source web address
Source csdms web address
Program license type Other
Program license type other
Memory requirements
Typical run time


Describe input parameters Backend: ROMSBuilder is written in Python and the main classes are ComponentBuilder.py and ROMSComponentBuilder.py. Default inputs are provided through roms_builder_input.cfg file. The three required input set on the tab dialogs for creating the new ROMS component are,

Header file path, this is the path to your header (*.h) file. The other option is to enter value into the tab dialogs. ex. /home/csdms/sims/roms_builder/upwelling Application name, this should be the name of your new ROMS Application and must be specified in UPPERCASE. ex. UPWELLING New component name, this is the name of the new component. As bocca cannot have two components with the same name, every time you create a new component the name should be unique.

Input format
Other input format
Describe output parameters ROMSBuilder creates the new component in home directory under "~/.cmt/components". It is safer not to edit the directory. Once a component is successfully created the next one goes relatively faster. To open the project user should go to "My Project > ROMSBuilder". The new project can only be seen by the owner. To share the project with the rest of the community please contact CSDMS.

Notes: Please wait for ROMSBuilder to finish before creating the next component. Overall run time is almost an hour for the first component. "Performance efficient mode" is not meant for ROMSBuilder, hence please avoid setting it on the tab dialogs. Default configuration settings is always that of UPWELLING. Please edit the config values to run your new roms component.

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
Describe key physical parameters and equations
Describe length scale and resolution constraints
Describe time scale and resolution constraints
Describe any numerical limitations and issues


Describe available calibration data sets
Upload calibration data sets if available:
Describe available test data sets
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
Can be coupled with:
Model info
Authors
Jisamma Kallumadikal
Source code
Model citations
Nr. of publications: --
Total citations: 0
h-index: --"--" is not a number.
m-quotient: 0
QR-code

Link to this page
Other models by author

Template:ROMSBuilder autokeywords


Introduction

History

References



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


See more publications of ROMSBuilder

Issues

Help

Model_help:ROMSBuilder

Input Files

Output Files

Download source code

Retrieved from "https://csdms.colorado.edu/csdms_wiki/index.php?title=Model:ROMSBuilder&oldid=299849"