A curated list of open technology projects to sustain a stable climate, energy supply, biodiversity and natural resources.

flux-data-qaqc

Provides a framework to create reproducible workflows for validation and analysis of eddy covariance data.
https://github.com/Open-ET/flux-data-qaqc

Category: Atmosphere
Sub Category: Meteorological Observation and Forecast

Keywords from Contributors

transforms measur archiving conversion observation animals optimize generic projection compose

Last synced: about 17 hours ago
JSON representation

Repository metadata

Energy Balance Closure Analysis and Eddy Flux Data Post-Processing

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 metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 6 days ago

Total Commits: 212
Total Committers: 6
Avg Commits per committer: 35.333
Development Distribution Score (DDS): 0.156

Commits in past year: 4
Committers in past year: 1
Avg Commits per committer in past year: 4.0
Development Distribution Score (DDS) in past year: 0.0

Name Email Commits
John Volk j****8@g****m 179
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:


Issue and Pull Request metadata

Last synced: 1 day ago

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 request: 22
Bot issues: 0
Bot pull requests: 23

Past year issues: 1
Past year pull requests: 0
Past year average time to close issues: N/A
Past year average time to close pull requests: N/A
Past year issue authors: 1
Past year pull request authors: 0
Past year average comments per issue: 1.0
Past year average comments per pull request: 0
Past year merged pull request: 0
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/Open-ET/flux-data-qaqc

Top Issue Authors

  • ashwinvis (2)
  • dgketchum (2)
  • inkenbrandt (2)
  • giswr (1)

Top Pull Request Authors

  • dependabot[bot] (23)
  • inkenbrandt (2)
  • pdebuyl (1)
  • dgketchum (1)

Top Issue Labels

Top Pull Request Labels

  • dependencies (23)

Package metadata

pypi.org: fluxdataqaqc

Tools for QA/QC of eddy covariance station data

  • Homepage: https://github.com/Open-ET/flux-data-qaqc
  • Documentation: https://fluxdataqaqc.readthedocs.io/
  • Licenses: BSD3
  • Latest release: 0.2.2 (published 5 months ago)
  • Last Synced: 2025-04-25T21:30:57.619Z (1 day ago)
  • Versions: 21
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 799 Last month
  • Rankings:
    • Dependent packages count: 10.103%
    • Forks count: 12.553%
    • Stargazers count: 14.56%
    • Average: 15.95%
    • Downloads: 20.927%
    • Dependent repos count: 21.607%
  • Maintainers (1)

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

Score: 11.87881779795857