Document model_params
and add examples to output_header_fields
and output_variables
#408
Labels
documentation
Improvements or additions to documentation
Document
model_params
and add examples tooutput_header_fields
andoutput_variables
in https://github.com/NOAA-OWP/ngen/blob/master/doc/BMI_MODELS.mdCurrent behavior
Items 2 and 3 above are documented but an example would be helpful. No examples found in code. Item 1 is not documented and needs to be added (see PR #368 and Bmi_C_Formulation_Test.cpp line 210).
Expected behavior
An example should be provided for
output_variables
andoutput_header_fields
at least similar to the one given forvariables_names_map
. Preferably, adding these to some multi-bmi realization file as an example would be helpful if it doesn't break any tests (it probably wouldn't). The scenario to be demonstrated is how to obtain multiple output variables from a combination of modules in a multi-BMI formulation.Also, documentation should stipulate that
output_variables
andoutput_header_fields
should (must?) be specified at the top level of a formulation rather than the module-level configs in a multi-BMI config.Similarly,
model_params
must be specified on the module config instead of the top-level formulation config, and this should be specified.Consider adding an applicability table similar to the one under the Required Parameters section for the optional parameters--though this would specify where they were allowed rather than where they were required.
Steps to replicate behavior (include URLs)
Screenshots
The text was updated successfully, but these errors were encountered: