# FluxnetLSM

**Repository Path**: hydro3/FluxnetLSM

## Basic Information

- **Project Name**: FluxnetLSM
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2019-12-10
- **Last Updated**: 2024-04-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

FluxnetLSM
=================

[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/kongdd/FluxnetLSM?branch=master&svg=true)](https://ci.appveyor.com/project/kongdd/FluxnetLSM)

R package for post-processing FLUXNET datasets for use in land surface modelling. Performs quality control and data conversion of FLUXNET data and collated site metadata. Supports `FLUXNET2015`, `La Thuile` and `OzFlux` data releases.


* N.B. options to check for level of gap-filling have changed since v1.0.

* Now using separate "missing" thresholds for met and flux variables, as well as
two tiers of gapfilling thresholds for met variables and a separate gap-fill
check for flux variables


## Installation

### Installing FluxnetLSM    
* Install with `devtools`: 

```{r}
# install.packages("devtools")
devtools::install_github("kongdd/FluxnetLSM")
```

* install in offline:

```{r}
$ git clone https://github.com/kongdd/FluxnetLSM.git
```
```{r}
install.packages("path_to_downloaded_package_files/FluxnetLSM", repos=NULL, type='source')
```

## Usage

See `examples` for example usage. Three examples are provided FLUXNET2015 and La Thuile for processing a single site or multiple sites:

- single site (`examples/*/example_conversion_single_site.R`)

- multiple sites (`examples/*/example_conversion_multiple_sites.R`)

- multiple sites using parallel programming (`examples/*/example_conversion_multiple_sites_parallel.R`)


## Troubleshooting

1. The package does not recognise the unit conversion

	Unit conversions are performed by the function `ChangeUnits`, you can find this under `R/Conversions.R`. A template is provided towards the end of this function for adding a new conversion.

2. I would like to output model-specific attributes for sites

	Model-specific attributes for each site, such as the plant functional type, can be saved in the `data/Site_metadata.csv` file (see example for CABLE PFT). Model-specific attributes are then set in the function `initialise_model` (stored in `R/Model_initialisations.R`) where a template for adding a new model attribute is provided. Finally, to write these in the NetCDF files, set the argument `model` to your model name when running the package.


## References

Ukkola, A. M., Haughton, N., De Kauwe, M. G., Abramowitz, G., and Pitman, A. J.: [FluxnetLSM R package (v1.0):
a community tool for processing FLUXNET data for use in land surface modelling](https://doi.org/10.5194/gmd-10-3379-2017),
Geosci. Model Dev., 10, 3379-3390, 2017