Metadata-Version: 2.3
Name: helioqc
Version: 0.2
Summary: Visual quality-control diagnostics for solar irradiance measurements (HelioQC multipanel).
Project-URL: Repository, https://github.com/oie-mines-paristech/HelioQC
Author-email: Yves-Marie Saint-Drenan | Mines Paris - PSL <yves-marie.saint-drenan@minesparis.psl.eu>, Raphaël Jolivet | Mines Paris - PSL <raphael.jolivet@minesparis.psl.eu>
License: MIT License
        
        Copyright (c) [2026] [Mines Paris - PSL]
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Keywords: irradiance,photovoltaic,quality-control,solar
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.10
Requires-Dist: click<9,>=8.1
Requires-Dist: ipykernel>=7.3.0
Requires-Dist: jupyter>=1.1.1
Requires-Dist: matplotlib<4,>=3.8
Requires-Dist: netcdf4>=1.7.3
Requires-Dist: numpy<2,>=1.26
Requires-Dist: pandas<3,>=2.0
Requires-Dist: pvlib<1,>=0.11
Requires-Dist: python-dotenv<2,>=1.0
Requires-Dist: sg2<3,>=2.3
Requires-Dist: tqdm<5,>=4.66
Requires-Dist: xarray>=2025.6.1
Provides-Extra: dev
Requires-Dist: build<2,>=1.2; extra == 'dev'
Requires-Dist: netcdf4<2,>=1.6; extra == 'dev'
Requires-Dist: pkginfo<2,>=1.12; extra == 'dev'
Requires-Dist: pytest-mock<4,>=3.14; extra == 'dev'
Requires-Dist: pytest<9,>=8; extra == 'dev'
Requires-Dist: tomli<3,>=2; (python_version < '3.11') and extra == 'dev'
Requires-Dist: tox-uv<2,>=1; extra == 'dev'
Requires-Dist: tox<5,>=4.19; extra == 'dev'
Requires-Dist: twine<7,>=6; extra == 'dev'
Description-Content-Type: text/markdown

# ☀️ ✅ HelioQC 

HelioQC is designed to support visual inspection of solar irradiance measurements, complementing automated quality-control (QC) tests. QC tests are essential for identifying measurements affected by instrumental or operational issues, and flagged measurements should be excluded from further analyses to prevent biases in applications such as model evaluation or development.

However, automated tests do not capture all anomalies. For example, some upper-limit tests may fail under cloudy conditions, as irradiance levels remain below the thresholds where these tests become effective. Therefore, the absence of QC flags does not guarantee that a measurement is correct.

In HelioQC, QC flags are treated as indicators of potential issues. A high frequency of flags should prompt further investigation, particularly through visual inspection. Although this step is often neglected due to being time-consuming and subjective, it is crucial for understanding anomalies and evaluating the true quality of the data.

To facilitate visual inspection, HelioQC provides a set of integrated visualizations in a multipanel layout, enabling the simultaneous interpretation of multiple diagnostics. This approach is based on the observation that different measurement issues can produce characteristic signatures across several visual representations. HelioQC thus offers a unified framework for QC data analysis, making the evaluation of solar irradiance measurements faster, more systematic, and more informative.

---
# Example output

![](https://raw.githubusercontent.com/oie-mines-paristech/HelioQC/main/res/sample-output.png)

---
## Setup

HelioQC is published as a Python package. Install in from [from PyPI](https://pypi.org/project/helioqc/):

```bash
pip install helioqc
```

---

## Usage

The HelioQC library provides both a **Python API** and **Shell command** (CLI).

The  [demonstration notebook](https://github.com/oie-mines-paristech/HelioQC/blob/main/demo.ipynb) provides detailed usage for both.

---

# Citation

**DOI:** `<TBD>`

---

# License

This software is released under the [MIT license](https://github.com/oie-mines-paristech/HelioQC/blob/main/LICENSE).

---

# Author

Yves-Marie Saint-Drenan (yves-marie.saint-drenan@minesparis.psl.eu) | [Mines Paris PSL](https://www.minesparis.psl.eu/) | [OIE](https://www.oie.minesparis.psl.eu/Accueil/)
