Functionally Assembled Terrestrial Ecosystem Simulator (FATES)

Overview

question Questions
  • How to run CLM-FATES with the CLM-FATES Galaxy tool?

  • How to upload input data for running CLM-FATES?

  • How to customize your runs?

  • How to analyze your model outputs?

  • How to create a workflow?

  • How to share your workflow?

objectives Objectives
  • Setting up a CLM-FATES case.

  • Customizing your run.

  • Interactive visualization with Panoply.

  • Automating your analyzes and visualisations of your CLM-FATES case.

  • Creating multi-case scenarios.

  • Composing, executing and publishing CML-FATES workflow.

requirements Requirements

time Time estimation: 4 hours

Supporting Materials

last_modification Last modification: Mar 23, 2021

Introduction

Terrestrial ecosystem models have been widely used to study the impact of climate changes on vegetation and terrestrial biogeochemical cycles in climate modelling community. They are also more and more applied in ecological studies to help ecologists to better understand the processes. But the technical challenges are still too high for most of the ecologists to use them. This practical aims at familiarizing you (especially ecologists) with running a terrestrial ecosystem model (i.e., CLM-FATES) at site-level in Galaxy and analyzing the model results. It will also teach you on how to create Galaxy workflow for your site-level CLM-FATES simulations to make your research fully reproducible. We hope this tutorial will promote the use of CLM-FATES and other terrestrial ecosystem models by a broader community.

Agenda

In this tutorial, we will cover:

  1. Get CLM-FATES input data
  2. Setting up a CLM-FATES simulation
  3. Quick visualization with Panoply
    1. Opening up Panoply
    2. Inspect metadata
  4. Using Galaxy tools for analysing your CLM-FATES simulation
  5. Convert your analysis history into a Galaxy workflow
  6. Change your CLM-FATES case and rerun your workflow
  7. Share your work
  8. Conclusion

comment Background

FATES is the “Functionally Assembled Terrestrial Ecosystem Simulator”, which is a vegetation demographic model (Fisher et al. 2017). FATES needs what we call a “Host Land Model” (HLM) to run and in this tutorial we will be using the Community Land Model of the Community Terrestrial Systems Model (CLM-CTSM). FATES was derived from the CLM Ecosystem Demography model (CLM(ED)), which was documented in Taking off the training wheels: the properties of a dynamic vegetation model without climate envelopes, CLM4.5(ED) 2015 and Koven et al. 2020. And this technical note was first published as an appendix to that paper. The FATES documentation will provide some more insight on FATES too.

Get CLM-FATES input data

Preparing CLM-FATES input data is out of scope for this tutorial. We assume the input data tarball contains the following folders:

atm   cpl   lnd   share

Each sub-folder will then contain all the necessary inputs for running your CLM-FATES case. For instance, ‘atm’ contains all the meteorological forcing data for running CLM-FATES. ‘lnd’ contains the data required to describe surface conditions (e.g., soil depth) for the model. More details about the model inputdata can be found in CLM and FATES documentation. For the purpose of this tutorial, input data for a single point location (ALP1) on the Norwegian alpine tundra ecosystem (Latitude: 61.0243N, Longitude: 8.12343E, Elevation: 1208 m) has been prepared and is ready to use. This is a site included in the modelling platform developed under [EMERALD project] (https://www.mn.uio.no/geo/english/research/projects/emerald/). More details about the sites can be found in Klanderud et al. 2015 and (missing reference)

hands_on Hands-on: Data upload

  1. Create a new history for this tutorial. If you are not inspired, you can name it fates.

    Tip: Creating a new history

    Click the new-history icon at the top of the history panelIf the new-history is missing:

    1. Click on the galaxy-gear icon (History options) on the top of the history panel
    2. Select the option Create New from the menu
  2. Import the input data and the restart dataset from Zenodo or from the shared data library. Restart dataset will be used if you want to initialize the model from exisiting experiments rather than running the model from a cold start to shorten spin-up time needed for the model.

    https://zenodo.org/record/4108341/files/inputdata_version2.0.0_ALP1.tar
    https://zenodo.org/record/4126404/files/CTSM_FATES-EMERALD_version2.0.0_ALP1_restart_2300-01-01.tar
    
    • Copy the link location
    • Open the Galaxy Upload Manager (galaxy-upload on the top-right of the tool panel)
    • Select Paste/Fetch Data
    • Paste the link into the text field
    • Press Start
    • Close the windowBy default, Galaxy uses the URL as the name, so rename the files with a more useful name.

    Tip: Importing data from a data library

    As an alternative to uploading the data from a URL or your computer, the files may also have been made available from a shared data library:

    • Go into Shared data (top panel) then Data libraries
    • Find the correct folder (ask your instructor)
    • Select the desired files
    • Click on the To History button near the top and select as Datasets from the dropdown menu
    • In the pop-up window, select the history you want to import the files to (or create a new one)
    • Click on Import
  3. Check the datatype (for both files) is tar

    Tip: Changing the datatype

    • Click on the galaxy-pencil pencil icon for the dataset to edit its attributes
    • In the central panel, click on the galaxy-chart-select-data Datatypes tab on the top
    • Select datatypes
    • Click the Change datatype button
  4. Rename galaxy-pencil datasets

    • Dataset names are the full URL, but this is not very nice to work with, and can even give errors for some tools
    • It is good practice to change the dataset names to something more meaningful and without any special characters
      • E.g. by stripping off the beginning of the URL
    • Example: rename https://zenodo.org/record/4108341/files/inputdata_version2.0.0_ALP1.tar to inputdata_version2.0.0_ALP1.tar
    • Do the same for the other dataset

    Tip: Renaming a dataset

    • Click on the galaxy-pencil pencil icon for the dataset to edit its attributes
    • In the central panel, change the Name field
    • Click the Save button

Setting up a CLM-FATES simulation

We will be using the CTSM/FATES-EMERALD Galaxy tool.This tool is based on the version of CLM-FATES that have been adapted to run at the sites included in the EMERALD project. More details about this model version can be found in README_fates_emerald_api

comment Tip: Finding your tool

Different Galaxy servers may have tools available under different sections, therefore it is often useful to use the search bar at the top of the tool panel to find your tool.

Additionally different servers may have multiple, similarly named tools which accomplish similar functions. When following tutorials, you should use precisely the tools that they describe. For real analyses, however, you will need to search among the various options to find the one that works for you.

comment Tip: Pre-selected tool parameters

When selecting a tool, Galaxy will pre-fill the tool parameters, selecting the first dataset with the corresponding type in your history. Be aware that very often, the default pre-selection is incorrect and do not correspond to the required dataset. So always check and update accordingly the tool parameters!

hands_on Hands-on: Creating a new CTSM/FATES-EMERALD case

  1. CTSM/FATES-EMERALD Tool: toolshed.g2.bx.psu.edu/repos/climate/ctsm_fates/ctsm_fates/2.0.1 with the following parameters:
    • param-file “inputdata for running FATES EMERALD”: inputdata_version2.0.0_ALP1.tar file from your history
    • “Name of your case”: ALP1_exp
    • In section “Customize the model run period”:
      • param-select “Determines the model run initialization type:: hybrid
        • “Reference case for hybrid or branch runs”: ALP1_refcase
        • “Reference date for hybrid or branch runs (yyyy-mm-dd)”: 2300-01-01
        • “Run start date (yyyy-mm-dd). Only used for startup or hybrid runs”: 0001-01-01
        • param-file “Restart for running FATES EMERALD”: CTSM_FATES-EMERALD_version2.0.0_ALP1_restart_2300-01-01.tar
      • “Provides a numerical count for STOP_OPTION”: 5
      • “Sets the run length along with STOP_N and STOP_DATE”: nyears

    comment Startup versus Hybrid

    When using startup, the FATES model will start from some arbitrary baseline state that is not linked to any previous run. Startup runs are typically initialized using a start date of 0001-01-01 except if you change it (start date option). For any scientific study, starting from an arbitraty baseline state implies you would need to run the model for a long period (between 100 and 200 years) before being able to use the model outputs. For this reason, we usually make a first simulation (spin-up) in startup mode and reuse this case as a baseline for our scientific study. We then use hybrid type and give additional inputs (restart files) to our simulation case. It is then important to specify the dates of your restart files. This is what we do in this tutorial.

  2. Check that the datatype galaxy-pencil of your outputs (history file) is netcdf
    • If this is not the case, please change the datatype now

    comment About CLM-FATES history files

    All the CLM-FATES history files are organized in a collection.

    comment About datatypes

    All the history files contain gridded data values written at specified times during the model run. Depending on the length of your simulation, you may have one or more history files that you can recognize from their names: ALP1_exp.clm2.h0.yyyy-mm-dd-sssss.nc (for non-monthly history files). Datatypes are, by default, automatically guessed. Here, as the prefix is .nc, the format is not always recognized as netcdf files. To cope with that, one can change the datatype manually, as shown below.

    Tip: Changing the datatype

    • Click on the galaxy-pencil pencil icon for the dataset to edit its attributes
    • In the central panel, click on the galaxy-chart-select-data Datatypes tab on the top
    • Select datatypes
    • Click the Change datatype button
  3. Rename galaxy-pencil the output dataset (history file) to ALP1_exp.nc

    Our FATES model has run for 5 years only, so we get a single output file. As previously, we recommend to rename all netCDF files so that they do not contain any special characters or dots (except for the file extension) or slashes. Some tools, in particular Panoply, won’t be able to recognize your file if not named properly.

    Tip: Renaming a dataset

    • Click on the galaxy-pencil pencil icon for the dataset to edit its attributes
    • In the central panel, change the Name field
    • Click the Save button
  4. NetCDF xarray Metadata Info Tool: toolshed.g2.bx.psu.edu/repos/ecology/xarray_metadata_info/xarray_metadata_info/0.15.1 to get metadata information for CLM-FATES netCDF outputs:
    • param-file “Netcdf file”: ALP1_exp.nc
  5. Inspect galaxy-eye the generated output files
    • Identify which variables would provide you some insights about canopy transpiration.

    question Questions

    1. What are the short names of the relevant variables? Which one will you pick if you want a result in mm/s?
    2. What are the dimensions of these variables?

    solution Solution

    1. FCTR is the canopy transpiration in W/m^2 and QVEGT is in mm/s. Therefore, we would select the latter.
    2. These variables are stored as a function of time and lndgrid and since we have only one grid cell, lngrid=1, hence the time series.

Quick visualization with Panoply

Opening up Panoply

hands_on Hands-on: Launch Panoply

Panoply plots geo-referenced and other arrays from netCDF and is available as a Galaxy interactive environment and may not be available on all Galaxy servers.

tip Tip: Launch Panoply in Galaxy

Currently Panoply in Galaxy is available on useGalaxy.eu instance, on the “Interactive tools” tool panel section or, as all interactive tools, from the dedicated useGalaxy.eu subdomain: Live.useGalaxy.eu. You may have to login again to Live.usrGalaxy.eu (use the same username and password than on other useGalaxy.eu subdomains) and switch to the correct history.

  1. Open the Panoply tool tool by clicking here
  2. Check ALP1_exp.nc dataset selected in the netcdf input field
  3. Click Execute
  4. The tool will start running and will stay running permanently
  5. Click on the “User” menu at the top and go to “Active Interactive Tools” and locate the Panoply instance you started.
  6. Click on your Panoply instance
    Panoply dataset selection
    Figure 1: Select dataset
  7. Click on ALP1_exp.nc dataset

Inspect metadata

hands_on Hands-on: Inspect dataset

  1. Inspect dataset content

    Here you can look at the dataset (ALP1_exp.nc) and related variables (FSDS, FSA, AREA_TREE, BIOMASS_CANOPY, etc.)

    question Question

    1. What is the long name of MORTALITY?
    2. What is its physical unit?

    solution Solution

    1. Rate of total mortality per PFT (Plat functional types)
    2. indiv/ha/yr
  2. Plot the total carbon in live plant leaves (LEAFC)

    Cutomize your plot and save it as png file in the output folder. Remember that if you do not save in the output folder, your plot will get lost.

    question Question

    1. Can you observe any pattern? Does it make any sense?

    solution Solution

    1. We can clearly see a seasonal cycle.
    Panoply LEAFC timeserie
    Figure 2: LEAFC
  3. Plot the rate of total mortality per PFT (MORTALITY)

    Select a 2D plot with time as x-axis and colored by the rate of total mortality per PFT (Plant functional type). Make sure to adjust the y-axis and save your plots in the output folder (as png file).

    question Question

    1. Can you observe any pattern? Does it make any sense?

    solution Solution

    1. We can clearly see a seasonal cycle of PFT2.
    Panoply MORTALITY per PFT
    Figure 3: total mortality per PFT

    comment Quit Panoply properly to save your plots!

    To make sure all your plots stored in outputs folder get exported to Galaxy, you need to quit panoply: File –> Quit Panoply.

Using Galaxy tools for analysing your CLM-FATES simulation

Panoply is a great tool for exploring the results of your simulations but what we would like is to automate the generation of the plots so that we can reuse it for any simulations.

hands_on Hands-on: Select and plot LEAFC

  1. NetCDF xarray Selection Tool: toolshed.g2.bx.psu.edu/repos/ecology/xarray_select/xarray_select/0.15.1 to select the total carbon in live plant leaves (LEAFC)
    • param-file “Input netcdf file”: ALP1_exp.nc
    • param-file “Tabular of variables”: Metadata info from ALP1_exp.nc (output of NetCDF xarray Metadata Info tool)
    • param-select “Choose the variable to extract”: LEAFC
  2. Rename galaxy-pencil dataset to NetCDF xarray Selection on ALP1_exp.nc

    Tip: Renaming a dataset

    • Click on the galaxy-pencil pencil icon for the dataset to edit its attributes
    • In the central panel, change the Name field
    • Click the Save button
  3. Replace parts of text Tool: toolshed.g2.bx.psu.edu/repos/bgruening/text_processing/tp_find_and_replace/1.1.3 to clean date column for plotting:
    • param-file “File to process”: NetCDF xarray Selection on ALP1_exp.nc
    • param-text “Find pattern”: 00:00:00
    • “Find-Pattern is a regular expression: No
    • “Replace all occurences of the pattern”: Yes
    • “Case-Insensitive search”: No
    • “Find whole-words”: Yes
    • “Ignore first line”: Yes
    • param-select “Find and Replace text in”: entire line
  4. Rename galaxy-pencil dataset to LEAFC_clean.tabular

    Tip: Renaming a dataset

    • Click on the galaxy-pencil pencil icon for the dataset to edit its attributes
    • In the central panel, change the Name field
    • Click the Save button
  5. Scatterplot w ggplot2 tool to plot the total carbon in live plant leaves (LEAFC):
    • param-file “Input in tabular format”: LEAFC_clean.tabular
    • “Column to plot on x-axis”: 1
    • “Column to plot on y-axis”: 4
    • “Plot title”: Total carbon in live plant leaves
    • “Label for x axis”: Time
    • “Label for y axis”: LEAFC (kgC ha-1)
    • In Advanced Options
      • param-select “Type of plot”: Points and Lines
    • In Output options
      • “width of output”:19.0
      • “height of output”: 5.0
  6. View galaxy-eye the resulting plot:

    LEAFC

Convert your analysis history into a Galaxy workflow

hands_on Hands-on: Extract workflow

  1. Go to the History Options menu galaxy-gear menu
    • Select the Extract Workflow option.
    • Remove any unwanted steps, in particular all steps with Panoply as we do not want to have interactive tools in our automated workflow..
  2. Rename the workflow to something descriptive
    • For example: CLM-FATES_ ALP1 simulation (5 years).
    • If there are any steps that shouldn’t be included in the workflow, you can uncheck them.
  3. Click “Create Workflow
    • Click on “edit” and check your workflow
    • Check all the steps

Change your CLM-FATES case and rerun your workflow

We would like to run a CLM-FATES case where the atmospheric Carbon Dioxyde Concentration (CO2) is increased by a factor of 4.

hands_on Hands-on: Compare the two simulations

Using the results from your two CLM-FATES simulations and the generated plots, assess the impact of an increase in the atmosperhic CO2 on the outputs of the model.

  1. Open the workflow editor

    Tip: Opening the workflow editor

    1. Click on the name of the imported workflowWorkflow drop down menu showing Edit option
    2. Select the Edit workflow to open the workflow in the workflow editor
  2. Edit your workflow and customize it to run your new CO2 experiment. For this you would need to:

    • In “Advanced customization”, change “Atmospheric CO2 molar ratio (by volume) only used when co2_type==constant (umol/mol)” from 367.0 to 1468.0.
    • Add an extra step to extract the first history file from the history collection: Extract Dataset Tool: EXTRACT_DATASET and make sure to select “netcdf” in the change datatype field.
    • Generate the corresponding plot. The final workflow would be similar to the one shown below:
    FATES workflow
    Figure 4: FATES workflow

    question Question

    1. Is the model response to this significant increase of atmospheric CO2 what you expected? Justify your answer.
    2. Is the current workflow (in particular the variables selected for the plots) the best choice? What changes/additions would you recommend?

    solution Solution

    1. Running 5 years is already sufficient to highlight significant changes. LEAFC 4xCO2
    2. Many suggestions can be given here. One simple addition can be the generation of plots where both simulations are represented on the same plot.

Share your work

One of the most important features of Galaxy comes at the end of an analysis. When you have published striking findings, it is important that other researchers are able to reproduce your in-silico experiment. Galaxy enables users to easily share their workflows and histories with others.

To share a history, click on the galaxy-gear icon in the history panel and select Share or Publish. On this page you can do 3 things:

  1. Make History Accessible via Link. This generates a link that you can give out to others. Anybody with this link will be able to view your history.
  2. Make History Accessible and Publish. This will not only create a link, but will also publish your history. This means your history will be listed under Shared Data → Histories in the top menu.
  3. Share with a user. This will share the history only with specific users on the Galaxy instance.

comment Permissions

Different servers have different default permission settings. Some servers create all of your datasets completely private to you, while others make them accessible if you know the secret ID.

Be sure to select Also make all objects within the History accessible whenever you make a history accessible via link, otherwise whomever you send your link to might not be able to see your history.

hands_on Hands-on: Share history

  1. Share your history with your neighbour (ask for his/her galaxy username).
  2. Find the history shared by your neighbour. Histories shared with specific users can be accessed by those users under their top masthead “User” menu under Histories shared with me.

comment Publish your history to https://workflowhub.eu/

One step further is to share your workflow on https://workflowhub.eu where it will be stored in a Galaxy workflow format as well as in Common Workflow Language. It provides standardised workflow identifiers and descriptions needed for workflow discovery, reuse, preservation, interoperability and monitoring and metadata harvesting using standard protocols. Please note that https://workflowhub.eu is still under active development.

Conclusion

We have learnt to run single-point simulations with FATES-CLM and generate workflows for multi-site scenarios.

keypoints Key points

  • CLM-FATES is a numerical terrestrial ecosystem model used in climate models

  • Panoply is a quick visualization tools for plotting your results

  • Multi-case simulations can be easily developed and shared with a Galaxy workflow

Frequently Asked Questions

Have questions about this tutorial? Check out the FAQ page for the Climate topic to see if your question is listed there. If not, please ask your question on the GTN Gitter Channel or the Galaxy Help Forum

References

  1. Taking off the training wheels: the properties of a dynamic vegetation model without climate envelopes, CLM4.5(ED), 2015. 10.5194/gmd-8-3593-2015
  2. Klanderud, K., V. Vandvik, and D. Goldberg, 2015 The Importance of Biotic vs. Abiotic Drivers of Local Plant Community Composition Along Regional Bioclimatic Gradients (C. Armas, Ed.). PLOS ONE 10: e0130205. 10.1371/journal.pone.0130205
  3. Fisher, R. A., C. D. Koven, W. R. L. Anderegg, B. O. Christoffersen, M. C. Dietze et al., 2017 Vegetation demographics in Earth System Models: A review of progress and priorities. Global Change Biology 24: 35–54. 10.1111/gcb.13910
  4. Koven, C. D., R. G. Knox, R. A. Fisher, J. Q. Chambers, B. O. Christoffersen et al., 2020 Benchmarking and parameter sensitivity of physiological and vegetation dynamics using the Functionally Assembled Terrestrial Ecosystem Simulator (FATES) at Barro Colorado Island, Panama. Biogeosciences 17: 3017–3044. 10.5194/bg-17-3017-2020

Feedback

Did you use this material as an instructor? Feel free to give us feedback on how it went.

Click here to load Google feedback frame

Citing this Tutorial

  1. Anne Fouilloux, Hui Tang, 2021 Functionally Assembled Terrestrial Ecosystem Simulator (FATES) (Galaxy Training Materials). /training-material/topics/climate/tutorials/fates/tutorial.html Online; accessed TODAY
  2. Batut et al., 2018 Community-Driven Data Analysis Training for Biology Cell Systems 10.1016/j.cels.2018.05.012

details BibTeX

@misc{climate-fates,
    author = "Anne Fouilloux and Hui Tang",
    title = "Functionally Assembled Terrestrial Ecosystem Simulator (FATES) (Galaxy Training Materials)",
    year = "2021",
    month = "03",
    day = "23"
    url = "\url{/training-material/topics/climate/tutorials/fates/tutorial.html}",
    note = "[Online; accessed TODAY]"
}
@article{Batut_2018,
        doi = {10.1016/j.cels.2018.05.012},
        url = {https://doi.org/10.1016%2Fj.cels.2018.05.012},
        year = 2018,
        month = {jun},
        publisher = {Elsevier {BV}},
        volume = {6},
        number = {6},
        pages = {752--758.e1},
        author = {B{\'{e}}r{\'{e}}nice Batut and Saskia Hiltemann and Andrea Bagnacani and Dannon Baker and Vivek Bhardwaj and Clemens Blank and Anthony Bretaudeau and Loraine Brillet-Gu{\'{e}}guen and Martin {\v{C}}ech and John Chilton and Dave Clements and Olivia Doppelt-Azeroual and Anika Erxleben and Mallory Ann Freeberg and Simon Gladman and Youri Hoogstrate and Hans-Rudolf Hotz and Torsten Houwaart and Pratik Jagtap and Delphine Larivi{\`{e}}re and Gildas Le Corguill{\'{e}} and Thomas Manke and Fabien Mareuil and Fidel Ram{\'{\i}}rez and Devon Ryan and Florian Christoph Sigloch and Nicola Soranzo and Joachim Wolff and Pavankumar Videm and Markus Wolfien and Aisanjiang Wubuli and Dilmurat Yusuf and James Taylor and Rolf Backofen and Anton Nekrutenko and Björn Grüning},
        title = {Community-Driven Data Analysis Training for Biology},
        journal = {Cell Systems}
}
                    

congratulations Congratulations on successfully completing this tutorial!