cavapy 2.0.2__tar.gz → 2.0.4__tar.gz

cavapy-2.0.4/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.

cavapy-2.0.4/PKG-INFO

@@ -0,0 +1,342 @@
+Metadata-Version: 2.4
+Name: cavapy
+Version: 2.0.4
+Summary: CAVA Python package. Retrive climate data.
+License: MIT
+License-File: LICENSE
+Author: Riccardo Soldan
+Author-email: riccardosoldan@hotmail.it
+Requires-Python: >=3.11,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: bottleneck
+Requires-Dist: cartopy
+Requires-Dist: dask
+Requires-Dist: llvmlite
+Requires-Dist: matplotlib
+Requires-Dist: netcdf4
+Requires-Dist: pydap
+Requires-Dist: seaborn
+Requires-Dist: tqdm
+Requires-Dist: xclim
+Requires-Dist: xsdba
+Project-URL: Repository, https://github.com/Risk-Team/cavapy
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="figures/cavapy_logo.svg" alt="cavapy logo" width="760">
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/cavapy/"><img src="https://img.shields.io/pypi/v/cavapy?label=PyPI&style=for-the-badge" alt="PyPI version"></a>
+  <a href="https://pepy.tech/project/cavapy"><img src="https://img.shields.io/pepy/dt/cavapy?style=for-the-badge&label=Downloads" alt="Total downloads"></a>
+  <img src="https://img.shields.io/badge/Python-3.11%2B-1f6feb?style=for-the-badge" alt="Python 3.11+">
+</p>
+
+<p align="center">
+  Retrieve, subset, and process CORDEX-CORE and ERA5 climate data directly from THREDDS/OPeNDAP.
+</p>
+
+<p align="center">
+  <a href="https://github.com/risk-team/cavapy/stargazers">Star this project on GitHub</a>
+</p>
+
+---
+
+## What is cavapy?
+
+Working with CORDEX-CORE climate projections normally means downloading terabytes of raw NetCDF files, reprojecting from rotated polar coordinates to regular lat/lon, writing boilerplate to handle non-Gregorian calendars, converting units, subsetting grids, wrangling multi-model ensembles, and layering bias correction on top. All before you can run a single analysis.
+
+`cavapy` collapses all of that into one function call.
+
+It streams only the spatial slice you need over OPeNDAP (no local archive required) and returns analysis-ready `xarray.DataArray` objects with consistent units, a standard Gregorian calendar, and optional bias correction already applied.
+
+It is part of the [CAVA](https://risk-team.github.io/CAVAanalytics/articles/CAVA.html) (Climate and Agriculture Risk Visualization and Assessment) ecosystem, a joint initiative of FAO, the University of Cantabria, the University of Cape Town, and Predictia.
+
+---
+
+## What gets handled automatically
+
+A single `get_climate_data()` call orchestrates a full pipeline:
+
+| Step | What happens |
+| --- | --- |
+| **Inventory lookup** | Resolves the correct OPeNDAP URL(s) for your GCM/RCM/RCP/domain combination from a live THREDDS inventory |
+| **Spatial subsetting** | Streams only the grid cells inside your country or bounding box — no full-file downloads |
+| **Country → bbox** | Converts a country name to a precise bounding box using Natural Earth shapefiles |
+| **Unit conversion** | K → °C for temperature; kg m⁻² s⁻¹ → mm/day for precipitation; J/m² → W/m² for solar radiation; 10 m → 2 m for wind speed |
+| **Regridding** | CORDEX outputs are natively in rotated polar coordinates; the data served here has already been regridded to a regular lat/lon grid, so standard spatial operations work out of the box |
+| **Calendar harmonization** | Converts 360-day and other non-Gregorian CORDEX calendars to Gregorian, filling gaps with NaN |
+| **Parallelization** | Variables are fetched in parallel processes; within each process, threaded downloads handle multi-file retrieval |
+| **Fault tolerance** | OPeNDAP connections retry up to 3 times with backoff; C-level noise is suppressed on intermediate attempts |
+| **Bias correction** | ERA5 is automatically fetched as the reference; EQM is trained and applied — no external tools needed |
+| **Domain validation** | If your bounding box falls outside the chosen CORDEX domain, a corrected domain is suggested |
+
+---
+
+## Data Coverage
+
+### Sources
+
+- CORDEX-CORE regional climate simulations (25 km)
+- ERA5 reanalysis (used directly and as the reference for bias correction)
+
+Data is hosted on the University of Cantabria THREDDS infrastructure.
+
+### Available datasets
+
+- **`CORDEX-CORE`** — original model outputs. Use this when you want raw projections or when you will apply your own post-processing.
+- **`CORDEX-CORE-BC`** — pre-bias-corrected outputs. The full CORDEX-CORE archive was corrected against ERA5 reanalysis using the [ISIMIP3 methodology](https://www.isimip.org/documents/413/ISIMIP3b_bias_adjustment_fact_sheet_GCMs_v2.pdf) (trend-preserving quantile mapping). Use this dataset when you need a consistent, ready-to-use ensemble with no additional processing.
+
+### Available variables
+
+| Variable | Description | Units |
+| --- | --- | --- |
+| `tas` | Daily mean temperature | °C |
+| `tasmax` | Daily maximum temperature | °C |
+| `tasmin` | Daily minimum temperature | °C |
+| `pr` | Daily precipitation | mm/day |
+| `hurs` | Daily relative humidity | % |
+| `sfcWind` | Daily wind speed at 2 m | m/s |
+| `rsds` | Daily solar radiation | W/m² |
+
+### Supported domains and scenario/model options
+
+- **Domains**: `NAM-22`, `EUR-22`, `AFR-22`, `EAS-22`, `SEA-22`, `WAS-22`, `AUS-22`, `SAM-22`, `CAM-22`
+- **RCPs**: `rcp26`, `rcp85`
+- **GCMs**: `MOHC`, `MPI`, `NCC`
+- **RCMs**: `REMO`, `Reg`
+
+---
+
+## Installation
+
+```bash
+conda create -n cavapy "python>=3.11"
+conda activate cavapy
+pip install cavapy
+```
+
+---
+
+## Quick Start
+
+### 1) Pre-bias-corrected projections (recommended)
+
+Uses `CORDEX-CORE-BC`: the full CORDEX archive already corrected against ERA5 using the ISIMIP3 methodology. No further correction is applied at download time.
+
+```python
+import cavapy
+
+togo = cavapy.get_climate_data(
+    country="Togo",
+    variables=["tasmax", "pr"],
+    cordex_domain="AFR-22",
+    rcp="rcp26",
+    gcm="MPI",
+    rcm="REMO",
+    years_up_to=2030,
+    dataset="CORDEX-CORE-BC",
+)
+# Returns: {"tasmax": xr.DataArray, "pr": xr.DataArray}
+```
+
+### 2) Original CORDEX-CORE with on-the-fly bias correction
+
+When `bias_correction=True`, cavapy automatically fetches ERA5 for the historical period and applies **Empirical Quantile Mapping (EQM)** via [xsdba](https://xsdba.readthedocs.io). Historical bias correction uses leave-one-out cross-validation to avoid overfitting. Multiplicative scaling is applied for precipitation, wind, and radiation; additive for temperature and humidity. This is useful when you need custom period or region coverage beyond the pre-corrected archive.
+
+```python
+import cavapy
+
+togo = cavapy.get_climate_data(
+    country="Togo",
+    variables=["tasmax", "pr"],
+    cordex_domain="AFR-22",
+    rcp="rcp26",
+    gcm="MPI",
+    rcm="REMO",
+    years_up_to=2030,
+    bias_correction=True,
+    dataset="CORDEX-CORE",
+)
+```
+
+### 3) ERA5 observations only
+
+```python
+import cavapy
+
+era5 = cavapy.get_climate_data(
+    country="Togo",
+    variables=["tasmax", "pr"],
+    obs=True,
+    years_obs=range(1980, 2019),
+)
+```
+
+---
+
+## Core Workflows
+
+### Projections + historical baseline
+
+Setting `historical=True` fetches the 1980–2005 historical simulation run and concatenates it with the projection period, giving a continuous time series.
+
+```python
+import cavapy
+
+data = cavapy.get_climate_data(
+    country="Afghanistan",
+    variables=["tasmax", "pr"],
+    cordex_domain="WAS-22",
+    rcp="rcp85",
+    gcm="NCC",
+    rcm="REMO",
+    years_up_to=2030,
+    historical=True,
+    dataset="CORDEX-CORE-BC",
+)
+```
+
+### Multi-model ensemble
+
+Pass lists (or `None` for all) to `rcp`, `gcm`, and `rcm`. Invalid combinations for the domain are skipped automatically with a warning, rather than raising an error.
+
+```python
+import cavapy
+
+multi = cavapy.get_climate_data(
+    country="Togo",
+    cordex_domain="AFR-22",
+    rcp=["rcp26", "rcp85"],
+    gcm=["MPI", "MOHC"],
+    rcm=["Reg", "REMO"],
+    years_up_to=2030,
+    historical=True,
+    dataset="CORDEX-CORE-BC",
+)
+```
+
+The return structure for multi-combination requests is a nested dict:
+
+```python
+multi[rcp][f"{gcm}-{rcm}"][variable]  # -> xarray.DataArray
+```
+
+### Custom bounding box
+
+```python
+import cavapy
+
+data = cavapy.get_climate_data(
+    country=None,
+    xlim=(30.0, 42.0),
+    ylim=(3.0, 15.0),
+    cordex_domain="AFR-22",
+    rcp="rcp85",
+    gcm="MPI",
+    rcm="REMO",
+    years_up_to=2050,
+    buffer=1,  # expand bbox by 1 degree on each side
+)
+```
+
+---
+
+## Parallelization
+
+`get_climate_data()` uses two levels of concurrency:
+
+- **Single model/scenario**: variables are processed in parallel across processes (default: one per variable), with threaded downloads inside each process
+- **Multiple models/scenarios**: combo × variable tasks are distributed across a global process pool (default cap: 6 processes); a live progress bar tracks completion
+- Sequential mode is used when `num_processes <= 1` or only one variable is requested
+
+### macOS and Windows scripts
+
+On macOS and Windows, Python starts multiprocessing workers with the `spawn` method. This means each worker imports the script again before running its task. If `get_climate_data()` is called at the top level of a `.py` script, that import re-runs the same call while Python is still starting the worker process, which can raise a multiprocessing bootstrapping `RuntimeError`.
+
+When using multiple variables or multi-model requests in a script on macOS or Windows, put the call behind Python's standard multiprocessing entry-point guard:
+
+```python
+import cavapy
+
+
+def main():
+    togo = cavapy.get_climate_data(
+        country="Togo",
+        variables=["tasmax", "pr"],
+        cordex_domain="AFR-22",
+        rcp="rcp26",
+        gcm="MPI",
+        rcm="REMO",
+        years_up_to=2030,
+        dataset="CORDEX-CORE-BC",
+    )
+    return togo
+
+
+if __name__ == "__main__":
+    main()
+```
+
+For a quick unguarded script, use `num_processes=1` or request a single variable to run sequentially.
+
+---
+
+## Plotting
+
+`cavapy` includes built-in plotting helpers that work directly on the returned DataArrays.
+
+### Spatial map
+
+```python
+import cavapy
+
+data = cavapy.get_climate_data(country="Togo", obs=True, years_obs=range(1990, 2011))
+
+fig = cavapy.plot_spatial_map(
+    data["tasmax"],
+    time_period=(2000, 2010),
+    title="Mean Max Temperature 2000-2010",
+    cmap="Reds",
+)
+```
+
+![Spatial temperature map](figures/spatial_map_temperature.png)
+
+### Time series
+
+```python
+fig = cavapy.plot_time_series(
+    data["pr"],
+    title="Precipitation Time Series - Togo (1990-2011)",
+    trend_line=True,
+    ylabel="Annual Precipitation (mm)",
+    aggregation="sum",
+    figsize=(12, 6),
+)
+```
+
+![Precipitation time series](figures/time_series_precipitation.png)
+
+For advanced visualization and reporting, see [CAVAanalytics](https://risk-team.github.io/CAVAanalytics/).
+
+---
+
+## Operational Notes
+
+- Check [GitHub issues](https://github.com/risk-team/cavapy/issues) for data server outages or announcements. cavapy fetches these automatically at startup.
+- Set `CAVAPY_NO_ANNOUNCEMENTS=1` to disable startup announcements in scripts or production runs.
+
+---
+
+## Citation and License
+
+- License: [MIT](LICENSE)
+- Package metadata and build details: [pyproject.toml](pyproject.toml)
+