Add FATES land use change module to pass LUH2 data to FATES #5760

glemieux · 2023-06-13T16:35:45Z

This pull request adds a new module, the structure of which is adopted from the dyn_subgrid code,
to enable e3sm to ingest minimally processed luh2 data to be passed to FATES.
A new namelist variable is introduced use_fates_luh, to engage the module functionality,
which is off by default. The luh2 dataset to be ingested is a minimally processed concatenation
of the luh2 state, transition and management datasets.

These changes also include a minor bug fix discovered in the process of developing the code,
in which if the number of FATES patches being defined by the user in the fates parameter file is greater than the max_patch_per_col elm variable, would result in a BalanceCheck error.

To be coordinated with NGEET/fates#1040

[nonBFB] for FATES

components/elm/src/dyn_subgrid/dynFATESLandUseChangeMod.F90

components/elm/src/main/elmfates_interfaceMod.F90

bishtgautam · 2023-06-27T19:43:11Z

@glemieux Can we add a new test for this PR?

glemieux · 2023-06-27T19:55:06Z

Status update: there is a forthcoming update to the fates luh2 data pipeline NGEET/fates#1032 that will result in an update to the default fates landuse data set. As such I've added "WIP" to this PR.

rljacob · 2023-07-06T17:48:36Z

status: probably another month waiting on FATES refactor.

rljacob · 2023-08-10T17:30:49Z

Need #5849 and also still WIP.

rljacob · 2023-09-07T17:51:40Z

#5849 was merged. Status now?

rljacob · 2023-09-21T17:26:04Z

@glemieux is this ready?

glemieux · 2023-09-21T17:30:12Z

@glemieux is this ready?

@rljacob This is still WIP and waiting on NGEET/fates#1040 updates. I'm actively working on this.

rljacob · 2023-10-12T17:36:59Z

update: still waiting on fates PR. Another couple of weeks.

rljacob · 2023-11-16T18:41:46Z

update: still WIP. 2 others will need to be merged before this.

rljacob · 2023-12-04T19:51:19Z

@glemieux can you list in a comment the PRs this is waiting on?

glemieux · 2023-12-04T22:06:14Z

@rljacob it needs to be staged after #6018 and #6027, both which need review and are undergoing some testing. Ultimately, it's also waiting on NGEET/fates#1040, but this should be integrated within the next week.

This PR needs to have some updates brought in, but is close to not being "WIP".

components/elm/src/biogeophys/SurfaceAlbedoMod.F90

components/elm/src/dyn_subgrid/dynFATESLandUseChangeMod.F90

rgknox

@glemieux and I are discussing some cosmetic things and checking on a setting in the namelist build perl code, but otherwise I think this PR looks good. @glemieux plans to add a test for this as well

rgknox · 2024-02-05T18:20:17Z

FYI: The next FATES API (33) is fairly simple, but I will hold on making that until this branch is re-based, since I have to build it on top of this one.

glemieux · 2024-02-05T18:27:45Z

update fates tag
add landuse testmod to fates test suite
remove use_cn return check from landusemod
add fluh_timeseries to setup_cmdl_fates_mode

Enable the host land model to input and interpolate raw land use harmonization data (LUH2) states and transitions to be passed to FATES.

glemieux · 2024-02-07T22:14:07Z

@peterdschwartz @rgknox I've taken care of the suggested changes and rebased this onto master now that #6027 is in. I'm going to start regression testing on this today and I've removed the '[WIP]'.

glemieux · 2024-02-16T19:27:21Z

@peterdschwartz regression testing on perlmutter with the e3sm_land_developer suite is complete and all expected non-fates tests are B4B. The qian smoke test from #6192 is failing, but that's because I hadn't rebased since last week. I've got a local rebased branch with #6219 included to make sure its not failing for a different reason. All fates test pass with expected DIFFs in non-landuse run modes since the tag update also includes a couple fates scientific bug fixes since sci.1.68.2_api.31.0.0.

peterdschwartz · 2024-02-16T19:39:12Z

@rgknox @bishtgautam This is ready to review then.

Edit: Needs to be re-approved after rebase.

glemieux · 2024-02-16T23:31:13Z

Just a quick update to note that rebasing against the latest master resulted in SMS.r05_r05.I1850ELMCN.pm-cpu_....elm-qian_1948 passing.

peterdschwartz · 2024-02-19T19:02:09Z

Tested on chrysalis and everything came back as expected. This can go in once it's got one approval

bishtgautam

I have a few minor comments. However, a major comment is: Shouldn't there be a new compset (say I20TRELMFATES) in which the transient LU data is used by FATES?

bishtgautam · 2024-02-19T20:27:48Z

components/elm/bld/namelist_files/namelist_defaults.xml

@@ -565,6 +565,11 @@ lnd/clm2/surfdata_map/surfdata_conusx4v1_simyr2000_c160503.nc</fsurdat>
 <flanduse_timeseries hgrid="ne30np4"       rcp="2.6" sim_year_range="1850-2100"
 use_crop=".false." >lnd/clm2/surfdata_map/surfdata.pftdyn_ne30np4_rcp2.6_simyr1850-2100_c130524.nc</flanduse_timeseries>

+<!-- Land Use Harmonization unified data sets for dynamic FATES land use change -->
+<fluh_timeseries hgrid="4x5" sim_year_range="1850-2015" use_fates=".true."
+ >lnd/clm2/surfdata_map/fates-sci.1.68.3_api.31.0.0_tools.1.0.1/LUH2_states_transitions_management.timeseries_4x5_hist_simyr1850-2015_c231101.nc</fluh_timeseries>


This file is not on the E3SM input data server.

FATES's SCI/API version number will continue to get updated. This would mean we would have many fates-sci* directories. How we have a single dir (e.g. lnd/clm2/surfdata_map/fates) and the metadata of the LUH2 file can include the information regarding the SCI/API version. In the F90 code, you can also include a sanity check regarding the SCI/API version.

@bishtgautam this file is fairly large. I submitted a request about 2 weeks ago to get access to the ANL servers using the procedure laid out on confluence so that I could load this and future updates directly. I haven't seen movement on that request. In the meantime, the data is on perlmutter; is this something you could upload for me via globus?

That should work. The file structure here was the recommended by ctsm folks, although I can't remember the rationale currently. I'll definitely add the fates sci/api version to the data file meta data. That said, the meta data check isn't really needed for usage here.

File is also on the other data server too https://svn-ccsm-inputdata.cgd.ucar.edu/trunk/inputdata/lnd/clm2/surfdata_map/fates-sci.1.68.3_api.31.0.0_tools.1.0.1/

bishtgautam · 2024-02-19T20:28:53Z

components/elm/bld/namelist_files/namelist_defaults.xml

@@ -127,7 +127,7 @@ attributes from the config_cache.xml file (with keys converted to upper-case).
 <!-- ================================================================== -->
 <!-- FATES default parameter file                                       -->
 <!-- ================================================================== -->
-<fates_paramfile >lnd/clm2/paramdata/fates_params_api25.5.0_12pft_c230710.nc</fates_paramfile>
+<fates_paramfile >lnd/clm2/paramdata/fates_params_api.32.0.0_12pft_c231215.nc</fates_paramfile>


This file is not available on https://web.lcrc.anl.gov/public/e3sm/inputdata/lnd/clm2/paramdata/

Thanks @bishtgautam I'll email you the file.

The file is on the other server though. https://svn-ccsm-inputdata.cgd.ucar.edu/trunk/inputdata/lnd/clm2/paramdata/

Oh, FATES also contributes code to CTSM, so it is on NCAR's server. In that case, we don't need to put on the E3SM server.

Oh nice, I didn't realize that! Thanks @peterdschwartz

components/elm/src/dyn_subgrid/dynFATESLandUseChangeMod.F90

glemieux · 2024-02-22T21:22:11Z

However, a major comment is: Shouldn't there be a new compset (say I20TRELMFATES) in which the transient LU data is used by FATES?

@bishtgautam Eventually we should have a compset for this, but with this PR I don't think its ideal as we're going to be bringing in a fates landuse v2 change in the next month or so. I think with the v2 update we will want to facilitate easier use of the option through the compset.

On a related note and by comparison, I think its definitely worth creating a fates SP mode compset with a future PR since that run mode is more mature.

peterdschwartz · 2024-02-26T20:02:12Z

Still waiting for the repo to be open.

…5760) This pull request adds a new module, the structure of which is adopted from the dyn_subgrid code, to enable e3sm to ingest minimally processed luh2 data to be passed to FATES. A new namelist variable is introduced use_fates_luh, to engage the module functionality, which is off by default. The luh2 dataset to be ingested is a minimally processed concatenation of the luh2 state, transition and management datasets. These changes also include a minor bug fix discovered in the process of developing the code, in which if the number of FATES patches being defined by the user in the fates parameter file is greater than the max_patch_per_col elm variable, would result in a BalanceCheck error. To be coordinated with NGEET/fates#1040 [nonBFB] for FATES

peterdschwartz · 2024-03-05T18:53:34Z

merged to next

glemieux mentioned this pull request Jun 13, 2023

v1 Land Use Change NGEET/fates#1040

Merged

5 tasks

rljacob assigned peterdschwartz Jun 19, 2023

rljacob requested a review from rgknox June 19, 2023 23:13

rljacob added Land FATES labels Jun 19, 2023

bishtgautam reviewed Jun 27, 2023

View reviewed changes

components/elm/src/dyn_subgrid/dynFATESLandUseChangeMod.F90 Outdated Show resolved Hide resolved

bishtgautam reviewed Jun 27, 2023

View reviewed changes

components/elm/src/main/elmfates_interfaceMod.F90 Outdated Show resolved Hide resolved

glemieux changed the title ~~Add FATES land use change module to pass LUH2 data to FATES~~ WIP: Add FATES land use change module to pass LUH2 data to FATES Jun 27, 2023

glemieux changed the title ~~WIP: Add FATES land use change module to pass LUH2 data to FATES~~ [WIP] Add FATES land use change module to pass LUH2 data to FATES Jun 27, 2023

glemieux mentioned this pull request Aug 8, 2023

Update FATES type names to facilitate refactor #5849

Merged

glemieux force-pushed the lnd/fates-luh2 branch from 5cad3f5 to 02c9635 Compare August 9, 2023 23:37

ckoven mentioned this pull request Sep 1, 2023

Develop LandUse x PFT static data file tool glemieux/fates#30

Open

1 task

glemieux force-pushed the lnd/fates-luh2 branch from d6b80aa to c3b6d91 Compare September 5, 2023 22:54

glemieux mentioned this pull request Oct 9, 2023

Index out of bound error for rhol when FATES patches requested is above 16 #5977

Open

rgknox reviewed Feb 5, 2024

View reviewed changes

components/elm/src/biogeophys/SurfaceAlbedoMod.F90 Show resolved Hide resolved

rgknox reviewed Feb 5, 2024

View reviewed changes

components/elm/src/dyn_subgrid/dynFATESLandUseChangeMod.F90 Outdated Show resolved Hide resolved

rgknox reviewed Feb 5, 2024

View reviewed changes

glemieux force-pushed the lnd/fates-luh2 branch 2 times, most recently from 5d54629 to 0fe12be Compare February 7, 2024 21:04

glemieux added 2 commits February 7, 2024 14:11

Add fates land use module

cbb0890

Enable the host land model to input and interpolate raw land use harmonization data (LUH2) states and transitions to be passed to FATES.

add logic to avoid rho and tau calculation when fates is on

1bffbfe

glemieux force-pushed the lnd/fates-luh2 branch from 3722f20 to 1bffbfe Compare February 7, 2024 22:11

glemieux changed the title ~~[WIP] Add FATES land use change module to pass LUH2 data to FATES~~ Add FATES land use change module to pass LUH2 data to FATES Feb 7, 2024

glemieux added 2 commits February 8, 2024 17:20

add fates landuse data default and update fates default paramfile

b559bd3

remove depricated fates history variables from fates testmods

088b63f

glemieux mentioned this pull request Feb 10, 2024

Carbon Imbalance with CN runs #6203

Closed

bishtgautam requested changes Feb 19, 2024

View reviewed changes

add code comment describing variable short names

f09f5e3

rgknox self-requested a review February 21, 2024 01:26

rgknox approved these changes Feb 21, 2024

View reviewed changes

bishtgautam self-requested a review February 22, 2024 21:28

bishtgautam approved these changes Feb 22, 2024

View reviewed changes

rgknox mentioned this pull request Mar 4, 2024

fates api 33 compatibility, two-stream radiation #6279

Merged

peterdschwartz merged commit 069c226 into E3SM-Project:master Mar 6, 2024
10 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add FATES land use change module to pass LUH2 data to FATES #5760

Add FATES land use change module to pass LUH2 data to FATES #5760

glemieux commented Jun 13, 2023 •

edited by peterdschwartz

Loading

bishtgautam commented Jun 27, 2023

glemieux commented Jun 27, 2023

rljacob commented Jul 6, 2023

rljacob commented Aug 10, 2023

rljacob commented Sep 7, 2023

rljacob commented Sep 21, 2023

glemieux commented Sep 21, 2023 •

edited

Loading

rljacob commented Oct 12, 2023

rljacob commented Nov 16, 2023

rljacob commented Dec 4, 2023

glemieux commented Dec 4, 2023

rgknox left a comment

rgknox commented Feb 5, 2024

glemieux commented Feb 5, 2024 •

edited

Loading

glemieux commented Feb 7, 2024 •

edited

Loading

glemieux commented Feb 16, 2024

peterdschwartz commented Feb 16, 2024 •

edited

Loading

glemieux commented Feb 16, 2024

peterdschwartz commented Feb 19, 2024

bishtgautam left a comment

bishtgautam Feb 19, 2024

glemieux Feb 20, 2024

peterdschwartz Feb 20, 2024

bishtgautam Feb 19, 2024

glemieux Feb 20, 2024

peterdschwartz Feb 20, 2024

bishtgautam Feb 20, 2024

glemieux Feb 20, 2024

glemieux commented Feb 22, 2024 •

edited

Loading

peterdschwartz commented Feb 26, 2024

peterdschwartz commented Mar 5, 2024

Add FATES land use change module to pass LUH2 data to FATES #5760

Add FATES land use change module to pass LUH2 data to FATES #5760

Conversation

glemieux commented Jun 13, 2023 • edited by peterdschwartz Loading

bishtgautam commented Jun 27, 2023

glemieux commented Jun 27, 2023

rljacob commented Jul 6, 2023

rljacob commented Aug 10, 2023

rljacob commented Sep 7, 2023

rljacob commented Sep 21, 2023

glemieux commented Sep 21, 2023 • edited Loading

rljacob commented Oct 12, 2023

rljacob commented Nov 16, 2023

rljacob commented Dec 4, 2023

glemieux commented Dec 4, 2023

rgknox left a comment

Choose a reason for hiding this comment

rgknox commented Feb 5, 2024

glemieux commented Feb 5, 2024 • edited Loading

glemieux commented Feb 7, 2024 • edited Loading

glemieux commented Feb 16, 2024

peterdschwartz commented Feb 16, 2024 • edited Loading

glemieux commented Feb 16, 2024

peterdschwartz commented Feb 19, 2024

bishtgautam left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

glemieux commented Feb 22, 2024 • edited Loading

peterdschwartz commented Feb 26, 2024

peterdschwartz commented Mar 5, 2024

glemieux commented Jun 13, 2023 •

edited by peterdschwartz

Loading

glemieux commented Sep 21, 2023 •

edited

Loading

glemieux commented Feb 5, 2024 •

edited

Loading

glemieux commented Feb 7, 2024 •

edited

Loading

peterdschwartz commented Feb 16, 2024 •

edited

Loading

glemieux commented Feb 22, 2024 •

edited

Loading