FATES land use data processing tool

A python tool for processing LUH2 data for use with FATES landuse run modes

Purpose

This tool takes the raw Land Use Harmonization, or LUH2, data files as input and prepares them for use with FATES. The tool concatenates the various raw data sets into a single file and provides the ability to regrid the source data resolution to a target resolution that the user designates. The output data is then usable by FATES, mediated through a host land model (currently either CTSM or E3SM).

Installation

This package is available through the ngeetropics anaconda channel:

To install in an existing environment:

conda install ngeetropics::tools-fates-landusedata

To install the tool in a new environment:

conda create -n <new-env-name> ngeetropics::tools-fates-landusedata

Usage

This tool is meant to be utilized from the command line. The top level call for the command line with help is shown below:

$ fates-landusedata -h
usage: fates-landusedata [-h] {luh2,lupft} ...

FATES landuse data tool

options:
  -h, --help    show this help message and exit

subcommands:
  {luh2,lupft}  landuse data tool subcommand options
    luh2        generate landuse harmonization timeseries data output
    lupft       generate landuse x pft static data map output

The luh2 subcommand call tells the tool to build the combined landuse timeseries data:

$ fates-landusedata luh2 -h
usage: luh2 [-h] [-w REGRIDDER_WEIGHTS] [-b BEGIN] [-e END] [-o OUTPUT] regrid_target_file luh2_static_file luh2_states_file luh2_transitions_file luh2_management_file

positional arguments:
  regrid_target_file    target surface data file with desired grid resolution
  luh2_static_file      luh2 static data file
  luh2_states_file      full path of luh2 raw states file
  luh2_transitions_file
                        full path of luh2 raw transitions file
  luh2_management_file  full path of luh2 raw management file

options:
  -h, --help            show this help message and exit
  -w REGRIDDER_WEIGHTS, --regridder_weights REGRIDDER_WEIGHTS
                        filename of regridder weights to save
  -b BEGIN, --begin BEGIN
                        beginning of date range of interest
  -e END, --end END     ending of date range to slice
  -o OUTPUT, --output OUTPUT
                        output filename

The lupft subcommand tells the tool to build the landuse x pft mapping file:

$ fates-landusedata lupft -h
usage: lupft [-h] [-o OUTPUT] regrid_target_file luh2_static_file clm_luhforest_file clm_luhpasture_file clm_luhother_file clm_surface_file

positional arguments:
  regrid_target_file    target surface data file with desired grid resolution
  luh2_static_file      luh2 static data file
  clm_luhforest_file    CLM5_current_luhforest_deg025.nc
  clm_luhpasture_file   CLM5_current_luhpasture_deg025.nc
  clm_luhother_file     CLM5_current_luhother_deg025.nc
  clm_surface_file      CLM5_current_surf_deg025.nc

options:
  -h, --help            show this help message and exit
  -o OUTPUT, --output OUTPUT
                        output filename