…ited to unit conversions

…to metavar.py and var_props.py

…n_capgen

feature/capgen: add new tests for unit conversions

Fix unit converter problem with units = 1

Merge main into feature/capgen (merge after NCAR#493)

Capgen cleanup

Testing updates

…o return the default value when variable doesn't have a value

…se' for optional var prop 'polymorphic'

…ult_val_optional_varprop

Bug fix in metavar.py: optional var props with a default value need t…

Constituents

This PR adds automatic conversions for supported unit and type transforms.
Also, included is a new ccpp variable property to indicate a scheme variables vertical orientation vertical, top_at_one.
As default, top_at_one is set to .false.(GFS ordering convention).
Adding top_at_one = .true. to a variable in a schemes metadata file will trigger automatic array flipping:

Addresses NCAR#329 and NCAR#403

Conversions supported:
https://github.com/NCAR/ccpp-framework/blob/main/scripts/conversion_tools/unit_conversion.py

---------

Co-authored-by: dustinswales <dswales@ucar.edu>
Co-authored-by: Grant Firl <grantf@ucar.edu>
Co-authored-by: Dom Heinzeller <dom.heinzeller@icloud.com>

… fix spelling: var_compatability --> var_compatibility (NCAR#512)

* Add capability to parse Fortran pointer variables to fortran_tools/parse_fortran.py
* Add --debug option to capgen (framework_env.py)
* For advection tests, add --debug flag to capgen and update test reports
* Add active attribute to variable water_vapor_specific_humidity in capgen_test, add --debug flag to capgen and update test reports
* For var_action tests, add --debug flag to capgen and update test reports
* Add docstring documentation for add_var_debug_check and write_var_debug_check in scripts/suite_objects.py
* Bug fix in scripts/suite_objects.py: also check variable allocations for variables local to the group and assign correct dimensions for local (group) and module (suite) variables
* Fix spelling: compatability --> compatibility

---------

Co-authored-by: mwaxmonsky <137746677+mwaxmonsky@users.noreply.github.com>

Expand var compatibility test for active attribute

NCAR#531)

Enable 1D variables with only a vertical dimension by removing code that always adds a dimension transform.

var_props.py: adjust logic that always adds vertical transform and is prohibiting 1D variables with a vertical coordinate

---------

Co-authored-by: Courtney Peverley <courtneyp@derecho5.hsn.de.hpc.ucar.edu>

Updates to enable more than one scheme group, and also enable unit transforms for scalar (non-dimensioned) variables.

Updated Files

Groups:
ccpp_suite.py - don't promote loop variables to suite level
host_cap.py - fix for iterating over suite part list
suite_objects.py - check if variable is at suite level before giving up hope and throwing an error

Scalar transforms:
suite_objects.py - don't try to do vertical dimension transform for scalar variable; conditionally write comments for var transform calls
var_props.py - don't include parenthesis (e.g. variable1() = 2 * variable2()) for scalar variable transforms

Misc:
metavar.py - fix for bug surely introduced by me converting to fstrings at some point

This PR adds support to use the fortran optional attribute at the scheme level in Capgen. This functionality does not replace the active attribute, but rather builds on it.

Previously, conditionally allocated fields needed by a scheme were required to be accompanied with the allocation logic defined by the host (e.g the "active" condition). With this change, the scheme can internally query the "presence" instead of carrying the host model logic "down into the scheme".

The following modifications were made:

Metadata parsing: Check for compatibility between scheme and host metadata. If host has inactive variable, ensure that scheme has variable declared as optional.
Fortran parsing: Check for consistency between metadata and fortran file. If fortran file does not contain the optional attribute in its declaration, report error.
For any optional scheme variable, add optional attribute to cap level declarations.
Declare null pointer at cap level when host does not use optional scheme variable

… into feature/merge_feature_capgen_into_main_20240308

… in unit metadata attribues

…ature/merge_feature_capgen_into_main_20240308