FATES-HLM API compatibility tables
The following table list the FATES API and the corresponding HLM tag associated with that API update. Note that CTSM provides a specific tag for each of its merge commits to the master branch whereas E3SM does not. As such, the hash for the relevant merge commit is provided for E3SM. Entries that specifically link to a pull request (e.g. PR#XXXX) are provided to note updates which have not been integrated yet, but are pending. The table may also include future planned API updates without links to provide users an advanced look at what updates are forthcoming.
API 45
This API update introduces a new namelist option that defines whether or not to kill vegetation during land use transitions
FATES Tag |
CTSM Tag |
E3SM Hash |
Update Type |
Short description |
|---|---|---|---|---|
TBD |
Science |
Complete FATES-CLM nitrogen coupling |
API 44
This API update introduces a new namelist option that defines whether or not to kill vegetation during land use transitions
FATES Tag |
CTSM Tag |
E3SM Hash |
Update Type |
Short description |
|---|---|---|---|---|
Science |
Add lupft seed bank diagnostics |
|||
Science |
Updates grazing logic to prevent off-season death |
|||
Skipped |
Software |
Updates check for missing values in land use data sets |
||
Science |
Add land use clearing option and update logic |
API 43
This API update changes the default format for the FATES parameter file. It now uses JSON formatting instead of CDL/NetCDF.
FATES Tag |
CTSM Tag |
E3SM Hash |
Update Type |
Short description |
|---|---|---|---|---|
Bug fix |
Fix to infinite loop in damage code |
|||
Bug fix |
Fixes initialization of cohort mean vcmax25 |
|||
Software |
Increase maximum patches and nocomp PFTs for range/pasture |
|||
Science |
Add new land use history variables |
|||
Bug fix |
Update hydraulic failure mortality for frozen soils |
|||
Science |
Add new history output for TRENDY runs |
|||
Software |
Refactors testing directory |
|||
Skipped |
Software |
NorESM no-comp calibration compatibility changes |
||
Bug fix |
Corrects unit conversion error for bc_out%ema_npp |
|||
Software |
Updates parameter file and tooling to JSON format |
API 42
This API update changes the way in which the HLM provides nutrient supplement status to FATES.
FATES Tag |
CTSM Tag |
E3SM Hash |
Update Type |
Short description |
|---|---|---|---|---|
Bug fix |
Adding cohort promotion/demotion protections |
|||
Bug fix |
Fixes negative tree LAI issue |
|||
Bug fix |
Updates to site-level mass tracking |
|||
Science |
Corrections to wind speed unit comments |
|||
Bug fix |
Fixes calculation between inventory and grid sites |
|||
Bug fix |
Fixes to event-based logging mortality |
|||
Science |
Add nutrient supplemenation status to dynamics |
API 41
This API updates the default parameter file with new parameters associated with a new managed fire capability that is associated with this tag as well. This also includes a fix to c3 cool grass for land use croplands.
FATES Tag |
CTSM Tag |
E3SM Hash |
Update Type |
Short description |
|---|---|---|---|---|
Bug fix |
Fixes to event-based logging mortality |
|||
Software |
Radiation error and profile diagnostic refactor |
|||
Science |
Rework site-level GPP and AR update being passed to the HLM |
|||
Software |
History level classification fixes to history diagnostics |
|||
Software |
Max canopy layer increased and promotion/demotion refactor |
|||
Science |
Add managed fire capability |
API 40
This API updates the default parameter file with simplification to the leaf phenology parameter options.
FATES Tag |
CTSM Tag |
E3SM Hash |
Update Type |
Short description |
|---|---|---|---|---|
Software |
Removes defunct wood product output |
|||
Bug fix |
Corrects issues with carbon biomass diagnostic output |
|||
Software |
Code cleanup removing unnecessary bc arguments |
|||
Science |
Add bc_out variables for HLM stock and flux calculations |
|||
Bug fix |
Fixes build issue accidentally introduced with last tag |
|||
Science |
Seed localization for no competition reduced complexity |
|||
Testing |
Fixes to unit testing per recent science updates |
|||
Software |
SPITFIRE refactor of mortality |
|||
Science |
Add Johnson and Berry 2021 electron transport model options |
|||
Bug fix |
Update trimming logic enforcment |
|||
Software |
Simplification of leaf phenology and parameter file updates |
API 39
This API update corrects issues with restarting FATES two-stream radiation and changes how zenith angles are updated and passed to FATES.
FATES Tag |
CTSM Tag |
E3SM Hash |
Update Type |
Short description |
|---|---|---|---|---|
Software |
Refactor and standardize per-ageclass history output |
|||
Science |
Two-stream sun-shade fraction update |
|||
Software |
Refactor of vegetation bin indexing |
|||
Bug fix |
Radation transmission bug fix |
|||
Bug fix |
Excess respiration unit fix for mass balance issue |
|||
Science |
Add site x pft expansions of seed bank history output |
|||
Bug fix |
Correct missing fire-induced carbon mortality history output |
|||
Bug fix |
Fixes two-stream radiation exact restart issue |
API 38
This breaking API update is due to the migration of the global FATES switches from the parameter file to the HLM namelists. This update will help improve testing and calibration automation by avoiding the need to generate a FATES parameter file if only the switch setting changes.
FATES Tag |
CTSM Tag |
E3SM Hash |
Update Type |
Short description |
|---|---|---|---|---|
Bug fix |
Harvesting bug fix for unoccupied canopy area |
|||
Bug fix |
Storage calculation issue due to incorrect nutrient targets |
|||
Software |
Refactor to leaf biophysics and addition of unit tests |
|||
Software |
Refactor spitfire order of operations |
|||
Software |
Migrate global FATES switches from parameter file to namelist |
API 37
API 37 captures the spitfire fuel equations refactor changes which renames and moves related variables into a new module.
FATES Tag |
CTSM Tag |
E3SM Hash |
Update Type |
Short description |
|---|---|---|---|---|
Software |
Patch convservation method added for two-stream radiation |
|||
Science |
Grazing feature added and default parameter file update |
|||
Software |
Patch numbering and no-competition clean up |
|||
Software |
Refactor cohort insertion and sorting methods |
|||
Bug fix |
Fix sort_cohorts to make sure cohort ordering is preserved |
|||
Bug fix |
Land use bug fixes and updates to the history output |
|||
Software |
Add runtime checks on the allometry mode settings |
|||
Bug fix |
Fix vegetation temperature weighting during phenology |
|||
Bug fix |
Corrects hydro sapflow output |
|||
Software |
Adds mechanism to avoid LAI exceeding allometry maximums |
|||
Bug fix |
Corrects when burnt fuel is zero’d and litter mass update |
|||
Software |
Refactor to the SPITFIRE rate-of-spread subroutine |
|||
Bug fix |
Corrects lack of direct mortality with area-based logging |
|||
Software |
Comprehensive singularity correction update to two-stream |
|||
Bug fix |
Avoids divide-by-zero crash when 100% allocation is to seeds |
|||
Bug fix |
Grass-specific cross-sectional area calculation fix |
|||
Science |
Growth respiration moved to daily timestep |
|||
Software |
Refactor SPITFIRE fuel equations |
API 36
API 36 captures updates and additions to the interface code for passing a new land use x pft mapping static dataset from the HLM I/O into FATES for land use run mode
FATES Tag |
CTSM Tag |
E3SM Hash |
Update Type |
Short description |
|---|---|---|---|---|
Bug fix |
Correction to inventory write statement |
|||
Software |
Updates to the patch insertion method |
|||
Science |
Time integrated flux diagnostics |
|||
Science |
Default parameter file update (arctic shrubs, grass allometry) |
|||
Software |
Fire-weather refactor (not-bfb) |
|||
Software |
Patch-level memory structure refactor |
|||
Science |
New sapwood, agb, and leaf allometries for grasses |
|||
Bug fix |
Land use transition matrix initialization |
|||
Bug fix |
Non-land use run modes fix |
|||
Science |
Land use version 2 [1] |
Pre-API 36
For compatibility with API 35 and earlier, please see Pre-API 36 FATES-HLM API Compatibility Table.