oeeil 0.1.0__tar.gz

oeeil-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

oeeil-0.1.0/NOTICE

@@ -0,0 +1,15 @@
+
+OEEIL
+
+
+
+Developed by Hâjar Abdaoui and Ines Yous, 2026.
+
+
+
+Developed in the context of the OEEIL Working Group (GT OEEIL) and the Master's degree thesis  in Health Engineering – Health Data Science at the University of Lille (UFR3S–ILIS), under the supervision of Dr Stephan Gabet. 
+
+
+
+This software is licensed under the Apache License, Version 2.0.
+

oeeil-0.1.0/PKG-INFO

@@ -0,0 +1,343 @@
+Metadata-Version: 2.4
+Name: oeeil
+Version: 0.1.0
+Summary: Python package for processing, analysing and visualising OEEIL environmental sensor data
+Author: Hajar Abdaoui, Ines Yous
+License-Expression: Apache-2.0
+Project-URL: Repository, https://github.com/NathalieAnemon/oeeil_package
+Project-URL: Issues, https://github.com/NathalieAnemon/oeeil_package/issues
+Keywords: air pollution,environmental exposure,portable sensors,microsensors,air quality,data processing
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: numpy
+Requires-Dist: pandas
+Requires-Dist: matplotlib
+Requires-Dist: geopy
+Requires-Dist: reportlab
+Requires-Dist: scikit-learn
+Requires-Dist: tzdata
+Dynamic: license-file
+
+# OEEIL
+
+**OEEIL** is a Python package for the automated processing, analysis, visualisation, and summarisation of data collected from portable environmental air-pollution microsensors.
+
+The package was developed as part of the 2025–2026 Master's degree in Health Engineering – Health Data Science at the University of Lille (UFR3S–ILIS), by **Hâjar Abdaoui** and **Ines Yous**, under the supervision of **Dr Stephan Gabet**. 
+
+The work was conducted within the **OEEIL Working Group (GT OEEIL)**, a multidisciplinary group bringing together Dr Stephan Gabet (University of Lille), **Nathalie Redon (IMT Nord Europe and Anemon Sensors)**, **Sahar Masmoudi (IMT Nord Europe)**, other researchers, PhD students and a postdoctoral researcher from IMT Nord Europe, as well as the two authors of this package. The working group aims to develop a structured and reproducible methodological framework for the processing and analysis of data collected from portable air-quality microsensors.
+
+Its initial development and validation were carried out using data from the **OEEIL sensor** (*Outil d'Évaluation de l'Exposition Individuelle*), a portable environmental microsensor developed within IMT Nord Europe and used for individual air-pollution exposure assessment.
+
+Current package version: **0.1.0**
+
+---
+
+## Purpose
+
+Fixed air-quality monitoring stations provide reliable reference measurements but do not fully capture the spatial and temporal variability of an individual's real-world exposure.
+
+Portable microsensors can complement these systems by collecting measurements close to individuals during daily activities and across different microenvironments. However, the resulting datasets require several processing steps before they can be interpreted reliably: harmonisation of heterogeneous files, time alignment, quality control, missing-data management, GPS processing, contextual enrichment, exposure analysis, visualisation, and reporting.
+
+OEEIL provides these steps in a **modular, configurable, reproducible, and reusable Python pipeline**.
+
+The package currently contains **32 main processing functions** organised around six functional areas, together with an additional public utility for imputation reporting.
+
+---
+
+## Main principles
+
+The package was designed around four principles:
+
+- **Modularity** – functions can be used independently or combined into a complete pipeline.
+- **Configurability** – thresholds, time windows, variable names, and processing criteria can be adapted to the study.
+- **Reproducibility** – identical data and parameters are intended to produce identical processing results.
+- **Adaptability** – the architecture is designed to be reusable beyond the OEEIL sensor, although transfer to other devices must be validated for each use case.
+
+---
+
+## Installation
+
+Once the package is available from PyPI:
+
+```bash
+pip install oeeil
+```
+
+For a local wheel:
+
+```bash
+pip install oeeil-0.1.0-py3-none-any.whl
+```
+
+OEEIL requires Python **3.10 or later**.
+
+Main dependencies:
+
+- numpy
+- pandas
+- matplotlib
+- geopy
+- reportlab
+- scikit-learn
+- tzdata
+
+---
+
+## Quick start
+
+The public API is intentionally flat: functions can be imported directly from `oeeil` without knowing the internal module structure.
+
+```python
+from oeeil import (
+    standardize_db,
+    convert_timezone,
+    filter_pollutant_outliers,
+    impute_missing_values,
+    classify_exposure_level,
+    visualize_exposure,
+)
+```
+
+Example:
+
+```python
+from oeeil import standardize_db
+
+df_standardized = standardize_db(df)
+```
+
+Several functions return both processed data and metadata. Refer to each function's docstring for its complete signature, parameters, output columns, and return objects.
+
+---
+
+# Functions
+
+## 1. Acquisition and standardisation
+
+### `standardize_db`
+Harmonises raw OEEIL datasets originating from different sensor generations and source structures. It standardises column names and data types and produces a common internal structure for downstream functions.
+
+### `convert_timezone`
+Converts OEEIL timestamps from UTC to a user-selected local time zone and adds local datetime information.
+
+### `aggregate_close_gps_points`
+Groups nearly identical GPS positions according to a user-defined distance threshold to reduce spatial redundancy during stationary periods.
+
+### `synchronize_oeeil_campaign`
+Synchronises several OEEIL DataFrames from the same campaign onto a common temporal basis while preserving sensor identifiers. The matching window is configurable to account for sensor resolution and clock offsets.
+
+### `synchronize_with_reference`
+Temporally synchronises an OEEIL dataset with an external reference dataset such as a regulatory air-quality station, fixed monitoring sensor, meteorological dataset, or another reference time series. The function handles differences in temporal resolution by aggregating the higher-frequency dataset around the lower-frequency grid. The current implementation keeps OEEIL and reference variables explicitly separated using suffixes, including when both inputs initially use identical column names.
+
+### `identify_calibration_pairs`
+Identifies OEEIL measurements located within a configurable geodesic radius of reference monitoring stations or other geolocated calibration points.
+
+---
+
+## 2. Preprocessing, signal quality and gas-signal normalisation, cross-sensitivity correction, and calibration
+
+### `detect_extinction_periods`
+Detects sensor shutdowns or acquisition gaps from timestamps and identifies post-restart warm-up periods. Affected observations can be flagged or removed.
+
+### `detect_pollution_events`
+Detects local pollution events using rolling statistics and a moving z-score. The function can add rolling means, z-scores, flags, and event labels.
+
+### `filter_pollutant_outliers`
+Detects short-duration instrumental spikes in pollutant signals. The current implementation uses time-based parameters such as amplitude threshold, maximum spike duration in seconds, and rolling-window duration in seconds. It infers the sampling interval from timestamps and converts durations into the appropriate number of observations. Artefacts can be replaced with `NaN` or retained with traceability flags.
+
+### `manage_missing_suppression`
+Applies configurable completeness criteria to identify and remove excessively incomplete data windows or sensors.
+
+### `impute_missing_values`
+Imputes missing measurements using temporal linear interpolation or K-nearest-neighbours (`KNN`) imputation, with traceability information for processed variables.
+
+### `print_imputation_report`
+Prints a readable summary of the imputation performed by `impute_missing_values`.
+
+### `flag_environmental_conditions`
+Adds a classification of environmental acquisition conditions according to configurable temperature and relative-humidity thresholds.
+
+### `normalize_gas_percentage`
+
+Provides a generalised framework for gas-signal normalisation, optional linear cross-sensitivity correction and linear deconvolution of multiple gas signals such as NO₂, O₃, and VOC.
+
+### `convert_mv_to_concentration`
+
+Converts raw or corrected gas-sensor signals from millivolts into concentration units using calibration against reference measurements. 
+
+## 3. Data processing and contextual enrichment
+
+### `interpolate_gps_coordinates`
+Interpolates short gaps in latitude and longitude using temporal linear interpolation and adds traceability information.
+
+### `compute_displacement_speed`
+Calculates displacement speed in km/h between consecutive geolocated observations.
+
+### `classify_transport_mode`
+Classifies observations into mobility categories from calculated speed. Categories include stationary periods, walking, bicycle/scooter, urban motorised transport, heavy transport, and train/motorway conditions.
+
+### `classify_indoor_outdoor_co2`
+Classifies observations as indoor, outdoor, or transition states from CO₂ measurements using configurable decision thresholds.
+
+### `detect_cov_outliers`
+Detects artefacts specific to the VOC signal and can flag them or replace affected values with missing values.
+
+### `normalize_cov_percentage`
+Normalises cleaned VOC measurements to a robust 0–100% scale. This VOC-specific function is retained for compatibility; for multi-gas processing or cross-sensitivity correction, use `normalize_gas_percentage`.
+
+### `classify_indoor_outdoor_cov`
+Combines CO₂-based information with VOC information to refine indoor/outdoor classification.
+
+### `correlate_transport_environment`
+Corrects physically inconsistent combinations between transport-mode and environment classifications according to explicit decision rules.
+
+---
+
+## 4. Advanced exposure analysis
+
+### `classify_exposure_level`
+Assigns qualitative exposure levels to selected pollutants using configurable thresholds: low, moderate, high, and very high.
+
+### `compute_exposure_indicators`
+Computes cumulative exposure indicators including concentration-time area under the curve (AUC), duration of critical exposure, time distribution by exposure level, and identification of the most critical pollutant.
+
+### `stratify_life_rhythm`
+Adds temporal strata describing periods of the day, day types, and user-defined life-rhythm segments.
+
+### `compute_daily_exposure`
+Aggregates exposure indicators at the daily scale while accounting for minimum data-coverage requirements. Outputs can include daily mean, maximum, AUC, critical-exposure duration, and coverage information.
+
+### `identify_critical_locations`
+Aggregates geolocated exposure data into spatial cells and identifies exposure hotspots according to configurable spatial criteria.
+
+---
+
+## 5. Visualisation
+
+### `visualize_exposure`
+Produces configurable pollutant time series, concentration distributions, hour/day heatmaps, and GPS-based exposure maps when coordinates are available.
+
+### `calendar_heatmap`
+Creates a calendar-style heatmap in which each cell represents a day and can be coloured according to an aggregated pollutant value or exposure level.
+
+### `statistical_summary_visual`
+Creates a multi-panel statistical dashboard summarising exposure indicators, exposure-level distributions, normalised temporal dynamics, and optional stratifications.
+
+---
+
+## 6. Reporting
+
+### `statistical_summary_report`
+Produces structured descriptive statistics at configurable temporal granularities: overall, hourly, daily, weekly, monthly, and stratified summaries.
+
+### `generate_report`
+Generates an automated PDF report from processed OEEIL data using ReportLab. The report can include campaign metadata, exposure indicators, pollutant distributions, figures, and stratified statistics.
+
+---
+
+# Example pipeline
+
+```python
+from oeeil import (
+    standardize_db,
+    convert_timezone,
+    detect_extinction_periods,
+    filter_pollutant_outliers,
+    impute_missing_values,
+    interpolate_gps_coordinates,
+    compute_displacement_speed,
+    classify_transport_mode,
+    classify_exposure_level,
+    compute_daily_exposure,
+)
+
+df = standardize_db(df)
+df = convert_timezone(df)
+df = detect_extinction_periods(df)
+df = filter_pollutant_outliers(df)
+
+df, imputation_metadata = impute_missing_values(df)
+
+df = interpolate_gps_coordinates(df)
+df = compute_displacement_speed(df)
+df = classify_transport_mode(df)
+
+df = classify_exposure_level(df)
+daily_exposure = compute_daily_exposure(df)
+```
+
+The exact return structure varies between functions. Some functions return a DataFrame directly, while others return additional metadata or structured result objects.
+
+---
+
+# Validation
+
+The initial package was developed and functionally tested using data from four OEEIL sensors collected during the MobiCard campaign in summer 2025:
+
+| Sensor | Measurement period | Measurements |
+|---|---:|---:|
+| OEI0012 | 03/07–10/07/2025 | 36,844 |
+| OEI0018 | 15/07–21/07/2025 | 30,015 |
+| OEI0020 | 02/07–10/07/2025 | 37,853 |
+| OEI0021 | 17/07–24/07/2025 | 32,075 |
+
+The initial validation dataset contained **136,787 measurements** collected over approximately 7-9 days per sensor.
+
+The package functions were tested for technical execution and output consistency. Functions that depend on external reference measurements require additional scientific or operational validation using real reference databases.
+
+The thesis dataset did not include a suitable colocation campaign with a regulatory reference instrument for NO₂, O₃, and VOC conversion. The new calibration and gas-deconvolution functions therefore provide the software framework for these operations, but their coefficients must be established and validated using appropriate experimental reference data before absolute exposure interpretation.
+
+---
+
+# Project status
+
+Version **0.1.0** is the first packaged release of the OEEIL processing framework.
+
+---
+
+# Authors
+
+- **Hâjar Abdaoui**
+- **Ines Yous**
+
+University of Lille  
+UFR Health and Sports Sciences - ILIS  
+Master's degree in Health Engineering - Health Data Science   
+Academic year 2025–2026
+
+Master's thesis:  
+*Development of a tool for the automated processing, visualisation and summarisation of data from an environmental air pollution sensor (OEEIL sensor)*
+
+Supervision: **Dr Stephan Gabet**
+
+---
+
+## Acknowledgements
+
+The development of this work was carried out within a multidisciplinary context involving the University of Lille, IMT Nord Europe, and contributors to the OEEIL working group.
+
+The authors particularly acknowledge **Dr Stephan Gabet** for scientific supervision, **Nathalie Redon** for her expertise on the OEEIL sensor and air-quality sensing, and the members of the OEEIL working group for their contributions to the methodological discussions.
+
+---
+
+## Citation
+
+If you use this package in academic work, please cite the associated Master's thesis until a dedicated software citation is provided:
+
+> Abdaoui H., Yous I. (2026). *Development of a tool for the automated processing, visualisation and summarisation of data from an environmental air pollution sensor (OEEIL sensor).* Master's degree thesis, University of Lille, UFR3S–ILIS.
+
+---
+
+## License
+
+OEEIL is distributed under the **Apache License 2.0**.
+
+See the [LICENSE](LICENSE) file for the full license terms and the [NOTICE](NOTICE) file for attribution information.