Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Revised the main README.md file to include links to more recent documentation.
I haven't changed the Doxygen part, but I think most of it could be moved from the readme file to a new Wiki page, as it right now most of the README is about Doxygen instead of ED2...
  • Loading branch information
mpaiao authored Feb 17, 2021
1 parent 02af322 commit 50d0fb0
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,21 @@
1. <a href="#doxyinfo"> General Doxygen Info </a>

## <a name="overview"> Model Overview </a>
The Ecosystem Demography Biosphere Model (ED2) is an integrated terrestrial biosphere model incorporating hydrology, land-surface biophysics, vegetation dynamics, and soil carbon and nitrogen biogeochemistry (Medvigy et al., 2009). Like its predecessor, ED (Hurtt et al., 1998, Moorcroft et al., 2001), ED2 utilizes a set of size- and age-structured partial differential equations that track the changing structure and composition of the plant canopy. With the ED2 model, in contrast to conventional biosphere models in which ecosystems with climatological grid cells are represented in a highly aggregated manner, the state of the aboveground ecosystem is described by the density of trees of different sizes and how this varies across horizontal space for a series of plant functional types. This more detailed description of ecosystem composition and structure enables the ED2 model to make realistic projections of both the fast-timescale exchanges of carbon, water and energy between the land and atmosphere, and long-term vegetation dynamics incorporating effects of ecosystem heterogeneity, including disturbance history and recovery (Hurtt et al., 2012).
The Ecosystem Demography Biosphere Model (ED2) is an integrated terrestrial biosphere model incorporating hydrology, land-surface biophysics, vegetation dynamics, and soil carbon and nitrogen biogeochemistry (<a href="https://dx.doi.org/10.5194/gmd-12-4309-2019">Longo et al. 2019</a>;<a href="https://dx.doi.org/10.1029/2008JG000812">Medvigy et al., 2009</a>). Like its predecessor, ED (<a href="https://dx.doi.org/10.1890/0012-9615(2001)071[0557:AMFSVD]2.0.CO;2">Moorcroft et al., 2001</a>), ED2 uses a set of size- and age-structured partial differential equations that track the changing structure and composition of the plant canopy. With the ED2 model, in contrast to conventional biosphere models in which ecosystems with climatological grid cells are represented in a highly aggregated manner, the state of the aboveground ecosystem is described by the density of trees of different sizes and how this varies across horizontal space for a series of plant functional types. This more detailed description of ecosystem composition and structure enables the ED2 model to make realistic projections of both the fast-timescale exchanges of carbon, water and energy between the land and atmosphere, and long-term vegetation dynamics incorporating effects of ecosystem heterogeneity, including disturbance history and recovery.

## <a name="contents"> Repository Contents </a>
Copies of the ED2 repository should contain the following directories:
- <b> BRAMS: </b> Contains the Brazilian Regional Atmospheric Model Somethingorother.
- <b> Doc: </b> Contains the ED2 documentation.
- <b> ED: </b> Contains the ED source code (src) and the directory for compilation (build). For further instructions on how to compile and use the model, we strongly suggest accessing the ED Wiki website: https://github.com/EDmodel/ED2/wiki
- <b> EDR: </b> Contains the source code (src), build (build), and basic run files (run) for a stripped-down version of the ED2 models radiative transfer scheme.
- <b> EDTS: </b> Contains the ED model test suite for evaluating the results of changes to the source code under a variety of run conditions.
- <b> Ramspost: </b> The Regional Atmospheric Model's Post Processor
- <b> RAPP: </b> This directory contains the NCEP reanalysis pre-processor, that produces meteorological forcing in the ED-friendly format (HDF5) based on the NCEP/NCAR reanalysis (Kalnay et al 1996). The source code (src) and a build directory are included. The run directory contains the namelist and a shell script to help with the downloading process. A brief instruction can be found in the directory too.
- <b> R-utils: </b> A collection of utilities for model pre- and post-processing.
- <b> BRAMS: </b> Contains a version of the Brazilian Developments on the Regional Atmospheric Model System (<a href="https://dx.doi.org/10.5194/gmd-10-189-2017">Freitas et al. 2017</a>) that was modified to run coupled biosphere-atmosphere simulations (<a href="https://dx.doi.org/10.5194/hess-19-241-2015">Knox et al. 2015</a>; <a href="https://dx.doi.org/10.1016/j.agrformet.2015.07.006">Swann et al. 2015</a>). <i>Note</i>: This has not been tested in a while, so the code may need updates to work with the most recent version of ED2.
- <b> Doc: </b> Contains additional ED2 documentation automatically generated with Doxygen.
- <b> Ramspost: </b> The BRAMS post-processing program, which generates GrADS files. <i>Note</i>: This has not been tested in a while, so the code may need updates to work with the most recent version of ED2.
- <b> RAPP: </b> This directory contains the NCEP reanalysis pre-processor, that produces meteorological forcing in the ED-friendly format (HDF5) based on the NCEP/NCAR reanalysis (Kalnay et al 1996). The source code (src) and a build directory are included. The run directory contains the namelist and a shell script to help with the downloading process. A brief instruction can be found in the directory too.<i>Note</i>: This has not been tested in a while, and other users have developed scripts to convert more up-to-date reanalyses.
- <b> R-utils: </b> A collection of R scripts utilities for model pre- and post-processing (mostly called by R scripts located in ED/Template).

## <a name="implementation"> Implementation Notes </a>
The primary data structure in ED, which can be found in ed_state_vars.f90, is a named, nested array of arrays. Each level of the heirarchy contains many fields of depth one, but the key large scale structure is as follows:
The primary data structure in ED, which can be found in ed_state_vars.F90, is a named, nested array of arrays. Each level of the heirarchy contains many fields of depth one, but the key large scale structure is as follows:
- <b> grid: </b> The most coarse data in the model. Basically just a simulation book-keeping linking of polygons.
- <b> polygon: </b> A collection of sites sharing a meteorology.
- <b> site: </b> A collection of patches sharing a common soil system and ground hydrology.
Expand All @@ -35,16 +35,16 @@ The primary data structure in ED, which can be found in ed_state_vars.f90, is a

Note: height and age, being continuous variables, are "binned". "Identical" in the above refers to bin membership.

If you're not sure where to start in browsing the documentation, consider looking at ed_model.f90, which controls the actual simulation of ecosystem processes. ed_driver.f90 and edmain.f90 mostly do model initialization and coordination of things like mpi.
## <a name="info"> Further Information </a>

## <a name="info"> Further Info </a>
This documentation includes clickable callgraphs and caller-graphs for each function in the code, except the routine "fatal_error" which is connected to just about everything.
- Most of the existing documentation on how to pre-process, compile, and run the ED2 model is available in our <a href="https://github.com/EDmodel/ED2/wiki">Wiki</a>.
- For the technical description of the various ED2 model features, we suggest looking at this <a href="https://github.com/EDmodel/ED2/wiki/References-for-technical-description-of-ED-2.2">reference list</a> (<b>Tip</b>: do not skip the Supporting Information of these papers, they contain relevant details).
- For a partial list of studies that have used ED or ED2, check <a href="https://github.com/EDmodel/ED2/wiki/Publications">here</a>.

More information about ED can be found in the paper written by
[Moorcroft et al.](http://flux.aos.wisc.edu/~adesai/documents/macrosys_papers-ankur/modeling/Moorcroft-EcolMono-EDmodel.pdf)

r956 aka 0c1bf644bd377bc0636c4f612b6f766f8e682599 from April 9th, is considered "somewhat stable", see report: https://github.com/EDmodel/ED2Documents/blob/master/EDTS/r956vr922rapid.pdf
##<a name="stable">Stable version</a>

- The latest stable version of the code (ED-2.2) can be found <a href="https://github.com/EDmodel/ED2/releases">here</a>.
- For former versions of ED or ED2, check the <a href="http://www.oeb.harvard.edu/faculty/moorcroft/code_and_data/index.html">Moorcroft Lab website</a>.

### <a name="doxygit"> Doxygen and Git Commits: </a>
In order for further pull requests to the mainline to be accepted, modified subroutines will require the following doxygen tags:
Expand Down

0 comments on commit 50d0fb0

Please sign in to comment.