2023.04

[2023.04] - 2023-12-04

Known Issues

• GCC 9 and below as well as GCC 11.1.0 are unsupported due to compilation issues. See prior releases for more details.
• NO_QUAD_PRECISION macro is no longer set by FMS, the ENABLE_QUAD_PRECISION macro has replaced prior usage of NO_QUAD_PRECISION. -DENABLE_QUAD_PRECISION should be set if quad precision is to be used, otherwise FMS will not use quad precision reals where applicable.

Added

• DATA_OVERRIDE: A new namelist flag use_data_table_yaml has been added to enable usage of the yaml format data_override tables. This allows an executable built with yaml support be able to accept either format.

Changed

• RESERVED KEYWORD CHANGES: Various routines in FMS have been updated to not use fortran keywords for variable names. The names changed were: data, unit, and value. This may affect usage of external code if argument names are explicitly used. Only required arguement names were changed to mitigate any breaking changes.
• TESTS: Changes the testing scripts to allow for the MPI_LAUNCHER environment variable override to work with any provided arguments.

Fixed

• CMAKE: Fixed build issue with CMake where precision default flags were being overwritten when using GNU and MPICH.
• AUTOTOOLS: Fixes issue affecting installs where the global libFMS.F90 module was not being installed correctly and adds post-install message.
• DIAG_MANAGER: Fixes issue with incorrect start_time functionality (from the 2023.02.01 patch)

Tag Commit Hashes

• 2023.04-beta1 be1856c

2023.03

[2023.03] - 2023-10-27

Known Issues

• GCC 9 and below as well as GCC 11.1.0 are unsupported due to compilation issues. See prior releases for more details.
• NO_QUAD_PRECISION macro is no longer set by FMS, the ENABLE_QUAD_PRECISION macro has replaced prior usage of NO_QUAD_PRECISION. -DENABLE_QUAD_PRECISION should be set if quad precision is to be used, otherwise FMS will not use quad precision reals where applicable.

Added

• UNIT_TESTS: New unit tests have been created or and existing ones expanded on for any modules utilizing mixed precision support.

Changed

• MIXED PRECISION: Most subroutines and functions in FMS have been updated to simultaneously accept both 4 byte and 8 byte reals as arguments. This deprecates the --enable-mixed-mode option, which enabled similar functionality but was limited to certain directories and was not enabled by default. To facilitate easier testing of these code changes, the CMake precision options for default real size were left in (along with an equivalent --disable-r8-default flag for autotools). The resulting libraries will support mixed-precision real kinds regardless of default real size. It should also be noted that many routines that accept real arguments have been moved to include files along with headers in order to be compiled with both kinds. Most module level variables were explicitly declared as r8_kind for these updates.
• Some type/module changes were made to facilitate mixed precision support. They are intended to have minimal impact to other codebases:
  • COUPLER_TYPES: In coupler_types.F90, coupler_nd_field_type and coupler_nd_values_type have been renamed to indicate real kind value: coupler_nd_real4/8_field_type and coupler_nd_real4/8_values_type. The bc field within coupler_nd_bc_type was modified to use r8_kind within the value and field types, and an additional field added bc_r4 to use r4_kind values.
  • TRIDIAGONAL: Module state between r4 and r8 calls are distinct (ie. subsequent calls will only be affected by calls of the same precision). This behaviour can be changed via the save_both_kinds optional argument to tri_invert.
• CODE_STYLE: has been updated to reflect the formatting used for the mixed precision support updates.

Fixed

• DIAG_MANAGER: Tile number (ie. tileX) will now be added to filenames for sub-regional diagnostics.
• MPP: Bug affecting non-intel compilers coming from uninitialized pointer in the nest_domain_type
• MPP: Bug fix for unallocated field causing seg faults in mpp_check_field
• FMS2_IO: Fixed segfault occuring from use of cray pointer remapping along with mpp_scatter/gather
• TEST_FMS: Added various fixes for different compilers within test programs for fms2_io, mpp, diag_manager, parser, and sat_vapor_pres.
• INTERPOLATOR: Deallocates fields in the type that were previously left out in interpolator_end

Removed

• CPP MACROS:
  • no_4byte_reals was removed and will not set any additional macros if used. no_8byte_integers is still functional.
  • NO_QUAD_PRECISION was removed. It was conditionally set if ENABLE_QUAD_PRECISION was undefined. ENABLE_QUAD_PRECISION should be used in model components instead (logic is flipped)
  • use_netCDF was set by autotools previously but wasn't consistently used in the code. FMS should always be compiled with netcdf installed so this was removed with the exception of its use in deprecated IO modules.
• DRIFTERS: The drifters subdirectory has been deprecated. It will only be compiled if using the -Duse_drifters CPP flag.

Tag Commit Hashes

• 2023.03-beta1 06b94a7
• 2023.03-alpha3 b25a7c5
• 2023.03-alpha2 9983ce3
• 2023.03-alpha1 a46bd94

2023.02.01

[2023.02.01] - 2023-10-13

Fixed

• DIAG_MANAGER: Fixes issue with incorrect start_time functionality

2023.02

[2023.02] - 2023-07-28

Known Issues

• GCC 11.1.0 is unsupported due to compilation issues with select type. The issue is resolved in later GCC releases.
• When outputting sub-region diagnostics, the current diag_manager does not add "tileX" to the filename when using a cube sphere. This leads to trouble when trying to combine the files and regrid them (if the region is in two different tiles)
• GCC 10 and greater causing io issues when compiled using O2 optimization flags
• GNU compilers prior to the GCC 9.0 release are unsupported for this release due to lack of support for the findloc intrinsic function. This will result in an error saying 'findloc' has no IMPLICIT type and can be resolved by compiling with gcc version 9.0 or greater.

Added

• MPP/EXCHANGE: Adds association checks before pointer deallocations in mpp includes and xgrid

Changed

• LIBFMS: The libFMS.F90 file (module name fms) meant to provide global access has been updated to include 'fms' and it's module/subdirectory name as prefixes for all names. This will only affect external codes that are already using the global module (via use fms) and not individual modules.
• MIXED PRECISION: Updates the axis_utils2, horiz_interp, sat_vapor_pressure, and axis_utils subdirectories to support mixed precision real values.
• FMS2_IO: Added in mpp_scatter and mpp_gather performance changes from the 2023.01.01 patch. See 2023.01.01 release notes for more details.
• FMS2_IO: Improved error messages to give more debugging information
• FMS_MOD: Changed fms_init to include a system call to set the stack size to unlimited, removed previously added stack size fixes
• MONIN_OBUKHOV: Restructures the subroutines in stable_mix interface so that 1d calls the underlying implementation, and 2 and 3d call it on 1d slices of the data as opposed to passing in mismatched arrays.
• MPP: Updates from JEDI for ajoint version the mpp halo filling (mpp_do_update_ad.fh), adds checkpoint for forward buffer information.

Fixed

• MPP: mpp_broadcast causing an unintended error message due to checking the wrong pe value
• MPP: Added workaround for GCC 12 issues causing errors with string lengths in fms2_io
• FMS2_IO: Fixed support for 'packed' data when using NF_SHORT variables. Scale_factor and add_offset attributes will now be applied if present.
• DOCS: Improved doxygen comments for tranlon, updated deployment action for site
• TESTS: Workaround added for ICE coming from mpp_alltoall test with intel 2022.3, and fixes for any test scripts missing input.nml creation. Fixes for mpp/test_global_array failures.
• TIME_INTERP: Fixes crashes when calling with a non-existant field
• DIAG_MANAGER: Fixes a module dependency issue causing failures during parallel builds
• AXIS_UTILS2: Fixes an out of bounds memory index

Removed

• FMS_IO/MPP_IO: The two older io modules, fms_io_mod and mpp_io_mod, have been deprecated and will not be compiled by default. If you wish to compile these modules, you must use the -Duse_deprecated_io CPP flag or the --enable-deprecated-io configure option if building with autotools.

Tag Commit Hashes

• 2023.02-beta1 2be8aa4
• 2023.02-alpha3 8c73bd1
• 2023.02-alpha2 783019f
• 2023.02-alpga1 419c66b

2023.01.01

[2023.01.01] - 2023-06-06

Known Issues

• GFORTRAN: GNU compilers prior to the GCC 9.0 release are unsupported for this release due to lack of support for the findloc intrinsic function. This will result in an error saying 'findloc' has no IMPLICIT type and can be resolved by compiling with gcc version 9.0 or greater.

Changed

• FMS2_IO: Performance changes for domain_reads_2d and domain_reads_3d:

  • Root pe reads the data
  • Uses mpp_scatter to send the data to the other pes
  • Added unit tests to test all of the domain_read/domain_write interfaces

• FMS2_IO: Performance changes for compressed_writes_1d/2d/3d

  • Uses mpp_gather to get data for write
  • Added unit tests to test all of the compressed writes interfaces
  • Compressed_writes_4d/5d were unchanged

• FMS2_IO: Extended mpp_scatter and mpp_gather to work for int8; added a kludge for scatter since the data is assumed to be (x,y,z)

2023.01

[2023.01] - 2023-04-03

Known Issues

• If using GCC 10 or higher as well as MPICH, compilation errors will occur unless -fallow-argument-mismatch is included in the Fortran compiler flags(the flag will now be added automatically if building with autotools or CMake).
• GCC 11.1.0 is unsupported due to compilation issues with select type. The issue is resolved in later GCC releases.
• When outputting sub-region diagnostics, the current diag_manager does not add "tileX" to the filename when using a cube sphere. This leads to trouble when trying to combine the files and regrid them (if the region is in two different tiles)

Added

• DIAG_MANAGER: Added code refactored as part of larger diag_manager rewrite for the send_data routines. The refactored code is disabled by default and enabled by setting use_refactored_send to true in the diag_manager_nml, and should mirror current behaviour.
• FMS2_IO: Added the ability to set deflate_level and shuffle netcdf options in fms2_io_nml. Also added functionality for registering dimensions as unlimited compressed.
• YAML_PARSER: Added support for emitting multiple tabbed section keys to allow diag manager yaml output

Changed

• STRING_UTILS: Extended the string interface in fms_string_utils_mod to accept reals of 4 or 8 kind, as well as 1, 2, and 3 dimensional real arrays
• DIAG_MANAGER: Changed the log_diag_field_info routine to allow for specifying seperator
• INTERPOLATOR(s): In horiz_interp, amip_interp and interpolator, changed pointers arrays into allocatables

Fixed

• TRIDIAGONAL: Added OMP directives to prevent race conditions
• DIAG_MANAGER: Added diag_send_data routine to fix class(*) related compiler issues from the refactor update
• SAT_VAPOR_PRES_K: Removed implied saves causing issues with class(*) type checking
• TIME_INTERP: Fixed naming conflicts between module level and local variables
• YAML_PARSER: Fixed typo in variable name, rename variables to avoid fortran keywords
• DOCS: Fixed incorrect serial build instructions
• COMPILER SUPPORT: Fixed compilation errors with Intel's llvm-based compiler and added support for the CMake build. Also fixed mpp_checksum unit test failures with openmpi and nvhpc compilation issues.
• TIME_MANAGER: Fixed an bug from PR #1169 that was causing answer changes in land models

Tag Commit Hashes

• 2023.01-beta4 (6362657)
• 2023.01-beta3 (0ff254e)
• 2023.01-beta2 (74d8e73)
• 2023.01-beta1 (6255971)
• 2023.01-alpha4 (4526cc9)
• 2023.01-alpha3 (f0e8cab)
• 2023.01-alpha2 (91e7324)
• 2023.01-alpha1 (203c8bf)

2022.04

[2022.04] - 2022-10-13

Known Issues

• If using GCC 10 or higher as well as MPICH, compilation errors will occur unless -fallow-argument-mismatch is included in the Fortran compiler flags(the flag will now be added automatically if building with autotools or CMake).
• GCC 11.1.0 is unsupported due to compilation issues with select type. The issue is resolved in later GCC releases.
• When outputting sub-region diagnostics, the current diag_manager does not add "tileX" to the filename when using a cube sphere. This leads to trouble when trying to combine the files and regrid them (if the region is in two different tiles)

Added

• FIELD MANAGER: Adds support for reading field tables in the yaml format (field_table.yaml).
  Yaml input only be used if compiled with -Duse_yaml preprocessor flag, otherwise it will default
  to previous behaviour. The converter script to convert current field tables to the new format is
  publicly available here, although the conversions will also be done automatically in FRE.
• FMS2_IO: Adds options to enable data compression and chunking for netcdf output in register_restart_field

Changed

• BUILD: Improves the configuration check for the MPICH/GCC 10+ argument mismatch bug by replacing it with a m4 compile test

Fixed

• Compiler Support: allows for compilation via the Cray/HP CCE compilers by fixing string concatenation compilation errors

Tag Commit Hashes

• 2022.04-beta2 163cb3e
• 2022.04-beta1 1099a28
• 2022.04-alpha4 8036d8d
• 2022.04-alpha3 7fafa4f
• 2022.04-alpha2 0c4b3cc
• 2022.04-alpha1 ec57a48

2022.03

[2022.03] - 2022-08-01

Known Issues

• If using GCC 10 or higher as well as MPICH, compilation errors will occur unless -fallow-argument-mismatch is included in the Fortran compiler flags(the flag will now be added automatically if building with autotools or CMake).
• GCC 11.1.0 is unsupported due to compilation issues with select type. The issue is resolved in later GCC releases.
• When outputting sub-region diagnostics, the current diag_manager does not add "tileX" to the filename when using a cube sphere. This leads to trouble when trying to combine the files and regrid them (if the region is in two different tiles)

Added

• BUILD: Adds checks to autotools and cmake build files to solve compilation issues with GCC 10 and greater. Also adds a debug build type for CMake to allow for overriding compiler flags, and individual override flags for mixed precision routines.
• DOCS: Additional information added for building and testing FMS with the build systems; renamed and moved autotools build document.
• YAML: Adds support for writing yaml files through the fms_yaml_output_mod module

Changed

• MIXED MODE: Expands support for mixed precision reals to the constants files, diag_manager, sat_vapor_pres, time_manager, and tracer_manager
• FMS_IO: Increased the character length for restart file names to allow for longer paths

Fixed

• COUPLER: Fixes global checksum being written to stdout by every core instead of just the root
• DOCS: Fixed parsing issues with include and header files, adds class diagrams and layout improvements

Tag Commit Hashes

• 2022.03-alpha1 6258854
• 2022.03-beta1 8a4ad84

2022.02

[2022.02] - 2022-04-29

Known Issues

• If using GCC 10 or higher as well as MPICH, compilation errors will occur unless -fallow-argument-mismatch is included in the Fortran compiler flags
• GCC 11.1.0 is unsupported due to compilation issues with select type. The issue is resolved in later GCC releases.

Added

• STRING_UTILS: Adds a module, fms_string_utils_mod, for common string operations throughout FMS
• LIBFMS: makes recently added routines available through the global fms module
• CMAKE: Adds build option for position independent code
• CONSTANTS: Adds macros to load constants for different modeling systems/uses between GFDL, GEOS and GFS. Can be selected in cmake with -DCONSTANTS=<GEOS|GFDL|GFS>

Changed

• STRING_UTILS: Refactored string routine definitions from fms_mod and fms2_io_mod to be located in fms_string_utils_mod
• CONSTANTS: Makes fmsconstants.F90 contain the constant definitions, with constants_mod refactored to hold the same values
• MOSAIC2: changes grid 'version' names and documentation to be more descriptive

Removed

• FMS_MOD: Removes fms_c.c and fms_c.h files from the fms directory

Fixed

• FMS2_IO: Fixed bug casuing non-root pe's to fail during the flush_file routine

Tag Commit Hashes

• 2022.02-alpha1 270c2a4
• 2022.02-alpha2 7768ad1
• 2022.02-beta1 689579e

2022.01

[2022.01] - 2022-03-25

Known Issues

• The MPICH MPI implementation is unsupported when used alongside GCC 10 or 11 due to compilation issues with the mixed precision reals. MPICH can still be used to compile FMS with GCC 9 or earlier, or with other compilers.
• GCC 11.1.0 is unsupported due to compilation issues with select type. The issue appears to be resolved in later GCC releases

Added

• FMS2_IO: Added a macro MAX_NUM_RESTART_VARS_ to allow the max amount of restart variables to be set at compile time
• TESTS: Adds a configure option, --enable-code-coverage, to build a code coverage report using intel's codecov via make check-code-coverage
• AFFINITY: Adds an initialization check to fms_affinity_set, and updates test program with init/end routines
• FMS2_IO: Adds an optional argument to ignore embedded checksum checks when reading restart files

Changed

• TESTING: Changes the testing suite scripts for various improvements such improved output, tests with input files, and adding/fixing new tests
• MPP: Change variable names in mpp to use more inclusive language
• DOCS: Updates to correct branch name and doxygen guide for functions, and adds CI information page

Fixed

• Fixes compilation warnings throughout the code, mainly for uninitialized or unused variables
• Fixed any code not adhering to the projects style guide (mainly line length fixes) so that all future changes can be checked with a linter
• MOSAIC2: Adds r8_kind casts to calls to C routines in order match precision of doubles
• TESTS: Fixes crashes in fms2_io tests from namelist read errors

Tag Commit Hashes

• 2022.01-alpha1 516a5ef
• 2022.01-beta1 12da128
• 2022.01-alpha2 28e8e3e
• 2022.01-beta2 7b78a73