cavapy 1.1.0__py3-none-any.whl → 1.1.5__py3-none-any.whl

{cavapy-1.1.0.dist-info → cavapy-1.1.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cavapy
-Version: 1.1.0
+Version: 1.1.5
 Summary: CAVA Python package. Retrive climate data.
 License: MIT
 License-File: LICENSE
@@ -100,6 +100,13 @@ The get_climate_data function performs automatically:
 - Convert into a Gregorian calendar (CORDEX-CORE models do not have a full 365 days calendar) through linear interpolation
 - Bias correction using the empirical quantile mapping (optional)
 
+### Parallelization strategy
+- If you request a single model/RCP combination, cavapy parallelizes **across variables** (one process per variable).
+- If you request multiple models and/or RCPs, cavapy parallelizes **across combo-variable tasks** (one process per variable per model), capped globally.
+- If `num_processes <= 1` or only one variable is requested, variables run sequentially (even for a single combo).
+- By default, up to **12 total processes** are used (capped by number of combo-variable tasks).
+- Inside each process, a thread pool handles per-variable downloads and observation/model fetches concurrently.
+
 ## Example usage
 
 Depending on the interest, downloading climate data can be done in a few different ways. Note that GCM stands for General Circulation Model while RCM stands for Regional Climate Model. As the climate data comes from the CORDEX-CORE initiative, users can choose between 3 different GCMs downscaled with two RCMs. In total, there are six simulations for any given domain (except for CAS-22 where only three are available).
@@ -238,6 +245,44 @@ import cavapy
 Togo_climate_data = cavapy.get_climate_data(country="Togo", variables=["tasmax", "pr"], obs=True,  years_obs=range(1980,2019))
 ```
 
+### Multiple models and/or RCPs
+
+You can pass lists (or None) to `rcp`, `gcm`, and `rcm`. If multiple combinations are requested,
+the return structure becomes nested:
+
+```
+results[rcp][f"{gcm}-{rcm}"][variable] -> DataArray
+```
+
+Example: all models and both RCPs for Togo (AFR-22):
+```
+import cavapy
+
+data = cavapy.get_climate_data(
+    country="Togo",
+    cordex_domain="AFR-22",
+    rcp=None,          # all RCPs
+    gcm=None,          # all GCMs
+    rcm=None,          # all RCMs
+    years_up_to=2030,
+    historical=True,
+    dataset="CORDEX-CORE",
+)
+```
+
+Example: specific models and RCPs:
+```
+data = 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,
+)
+```
+
 ## Plotting Functionality
 
 `cavapy` now includes built-in plotting functions to easily visualize your climate data as maps and time series. The plotting functions work seamlessly with the data returned by `get_climate_data()`. **However, if your main goal is visualisation, we strongly encourage you to check out [CAVAanalytics](https://risk-team.github.io/CAVAanalytics/), our R package**.

cavapy-1.1.5.dist-info/RECORD

@@ -0,0 +1,5 @@
+cavapy.py,sha256=SdCVxMgMBGkQA97mrWwnazLOmfwphWI7yFSisfFihpg,19586
+cavapy-1.1.5.dist-info/METADATA,sha256=2ftyfOcFYQX8bP-J99c9Bwh8nOwRgpfjpFXNKyLixaU,12184
+cavapy-1.1.5.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+cavapy-1.1.5.dist-info/licenses/LICENSE,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
+cavapy-1.1.5.dist-info/RECORD,,