Skip to content

Latest commit

 

History

History
81 lines (49 loc) · 3.22 KB

README.rst

File metadata and controls

81 lines (49 loc) · 3.22 KB
Raw
Documentation Status Automated tests

flux-data-qaqc

flux-data-qaqc provides a framework to create reproducible workflows for validation and analysis of eddy covariance data. The package is intended for those who need to post-process flux data, particularly for generating daily and monthly evapotranspiration (ET) timeseries estimates with energy balance closure corrections applied. Applications where this software may be useful include analysis of eddy covariance data, hydrologic or atmospheric model validation, and irrigation and water consumption studies.

Key functionalities and tools include:

  • data validation with methods for quality-based filtering
  • time series tools, e.g. gap-filling and temporal aggregation
  • energy balance closure algorithms and other meterological calculations
  • data provenance, e.g. from metadata management and file structure
  • downloading and management of gridMET meterological data
  • customizable and interactive visualizations
  • built-in unit conversions and batch processing tools

Documentation

ReadTheDocs

Installation

Using PIP:

pip install fluxdataqaqc

PIP should install the necessary dependencies however it is recommended to use conda and first install the provided virtual environment. This is useful to avoid changing your local Python environment. Note, flux-data-qaqc has been tested for Python 3.7+, although it may work with versions greater than or equal to 3.4.

First make sure you have the fluxdataqaqc environment file, you can download it here. Next to install run,

conda env create -f environment.yml

To activate the environment before using the flux-data-qaqc package run,

conda activate fluxdataqaqc

Now install using PIP:

pip install fluxdataqaqc

Now all package modules and tools should be available in your Python environment PATH and able to be imported. Note if you did not install the Conda virtual environment above, PIP should install dependencies automatically but be sure to be using a version of Python above or equal to 3.4. To test that everything has installed correctly by opening a Python interpretor or IDE and run the following:

import fluxdataqaqc

and

from fluxdataqaqc import Data, QaQc, Plot

If everything has been installed correctly you should get no errors.

How to cite

Volk et al., (2021). flux-data-qaqc: A Python Package for Energy Balance Closure and Post-Processing of Eddy Flux Data. Journal of Open Source Software, 6(66), 3418, https://doi.org/10.21105/joss.03418