Data

Tools

Indexes

Applications

Experiments

Open Source Science

flux-data-qaqc

flux-data-qaqc: A Python Package for Energy Balance Closure and Post-Processing of Eddy Flux Data - Published in JOSS (2021)

https://github.com/open-et/flux-data-qaqc

Science Score: 95.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 3 DOI reference(s) in README and JOSS metadata
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    1 of 6 committers (16.7%) from academic institutions
  • ○
    Institutional organization owner
  • ✓
    JOSS paper metadata
    Published in Journal of Open Source Software

Keywords from Contributors

mesh

Scientific Fields

Mathematics Computer Science - 84% confidence
Artificial Intelligence and Machine Learning Computer Science - 83% confidence
Earth and Environmental Sciences Physical Sciences - 64% confidence
Last synced: 4 months ago · JSON representation

Repository

Energy Balance Closure Analysis and Eddy Flux Data Post-Processing

Basic Info
  • Host: GitHub
  • Owner: Open-ET
  • License: bsd-3-clause
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 115 MB
Statistics
  • Stars: 31
  • Watchers: 9
  • Forks: 16
  • Open Issues: 2
  • Releases: 4
Created over 6 years ago · Last pushed 8 months ago
Metadata Files
Readme Changelog License

README.rst 

.. image:: https://readthedocs.org/projects/flux-data-qaqc/badge/?version=latest
   :target: https://flux-data-qaqc.readthedocs.io/en/latest/?badge=latest
   :alt: Documentation Status

.. image:: https://github.com/Open-ET/flux-data-qaqc/actions/workflows/fluxdataqaqc_tests.yml/badge.svg
   :target: https://github.com/Open-ET/flux-data-qaqc/actions/workflows/fluxdataqaqc_tests.yml
   :alt: 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:

.. code-block:: bash

   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,

.. code-block:: bash

   conda env create -f environment.yml

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

.. code-block:: bash

   conda activate fluxdataqaqc

Now install using PIP:

.. code-block:: bash

   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:

.. code-block:: python

   import fluxdataqaqc

and 

.. code-block:: python

   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

Owner

  • Name: Open ET
  • Login: Open-ET
  • Kind: organization

Repositories for the Open ET project, which aims to provide open and easily accessible evapotranspiration data for improved water management

JOSS Publication

flux-data-qaqc: A Python Package for Energy Balance Closure and Post-Processing of Eddy Flux Data
Published
October 16, 2021
DOI
Volume 6, Issue 66, Page 3418
Authors
John Volk ORCID
Desert Research Institue
Justin Huntington
Desert Research Institue
Richard Allen
University of Idaho
Forrest Melton
NASA Ames Research Center, California State University Monterey Bay
Martha Anderson
USDA Agricultural Research Service
Ayse Kilic
University of Nebraska Lincoln
Editor
Pierre de Buyl ORCID
Tags
eddy-covariance energy balance closure post-processing flux tower data
View PDF Review Thread Software Archive

GitHub Events

Total
  • Release event: 1
  • Watch event: 7
  • Issue comment event: 1
  • Member event: 1
  • Push event: 2
  • Fork event: 2
  • Create event: 1
Last Year
  • Release event: 1
  • Watch event: 7
  • Issue comment event: 1
  • Member event: 1
  • Push event: 2
  • Fork event: 2
  • Create event: 1

Committers

Last synced: 5 months ago

All Time
  • Total Commits: 213
  • Total Committers: 6
  • Avg Commits per committer: 35.5
  • Development Distribution Score (DDS): 0.155
Past Year
  • Commits: 3
  • Committers: 1
  • Avg Commits per committer: 3.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
John Volk j****8@g****m 180
dependabot[bot] 4****] 18
Christian Dunkerly c****y@d****u 11
Paul p****t@u****v 2
Pierre de Buyl p****l@p****e 1
David Ketchum d****m 1
Committer Domains (Top 20 + Academic)
pdebuyl.be: 1 utah.gov: 1 dri.edu: 1

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 7
  • Total pull requests: 27
  • Average time to close issues: 3 months
  • Average time to close pull requests: 25 days
  • Total issue authors: 4
  • Total pull request authors: 4
  • Average comments per issue: 2.29
  • Average comments per pull request: 0.15
  • Merged pull requests: 22
  • Bot issues: 0
  • Bot pull requests: 23
Past Year
  • Issues: 1
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 1.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • ashwinvis (2)
  • dgketchum (2)
  • inkenbrandt (2)
  • giswr (1)
Pull Request Authors
  • dependabot[bot] (24)
  • inkenbrandt (4)
  • pdebuyl (1)
  • dgketchum (1)
Top Labels
Issue Labels
Pull Request Labels
dependencies (24)

Packages

  • Total packages: 3
  • Total downloads:
    • pypi 98 last-month
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 1
    (may contain duplicates)
  • Total versions: 29
  • Total maintainers: 1
proxy.golang.org: github.com/Open-ET/flux-data-qaqc
  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 4 months ago
proxy.golang.org: github.com/open-et/flux-data-qaqc
  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 4 months ago
pypi.org: fluxdataqaqc

Tools for QA/QC of eddy covariance station data

  • Versions: 21
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 98 Last month
Rankings
Dependent packages count: 10.1%
Forks count: 12.6%
Stargazers count: 14.6%
Average: 15.9%
Downloads: 20.9%
Dependent repos count: 21.6%
Maintainers (1)
JohnVolk
Last synced: 4 months ago

Dependencies

environment.yml conda
  • bokeh >=2.0
  • netcdf4
  • numpy >=1.15
  • openpyxl
  • pandas >=1.0
  • python >=3.7
  • refet
  • scikit-learn
  • xarray
.github/workflows/fluxdataqaqc_tests.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
requirements.txt pypi
  • Jinja2 ==2.11.3
  • MarkupSafe ==1.1.1
  • Pillow ==9.3.0
  • PyYAML ==5.4
  • bokeh ==2.2.3
  • certifi ==2022.12.7
  • cftime ==1.2.1
  • et-xmlfile ==1.0.1
  • jdcal ==1.4.1
  • joblib ==1.2.0
  • netCDF4 ==1.5.4
  • numpy ==1.22.0
  • olefile ==0.46
  • openpyxl ==3.0.5
  • packaging ==20.4
  • pandas ==1.1.4
  • pip ==21.1
  • pyparsing ==2.4.7
  • python-dateutil ==2.8.1
  • pytz ==2020.4
  • refet ==0.3.10
  • scikit-learn ==0.23.2
  • scipy ==1.5.3
  • setuptools ==65.5.1
  • six ==1.15.0
  • threadpoolctl ==2.1.0
  • tornado ==6.1
  • typing-extensions ==3.7.4.3
  • wheel ==0.38.1
  • xarray ==0.16.1
  • xlrd ==1.2.0