geoaquacrop-preprocess 0.1.0__tar.gz

geoaquacrop_preprocess-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 2026 Josias Lang-Ritter, Christopher Bowden, Seyed Hossein Hosseini, Henrikki Tenkanen, Timothy Foster
+
+   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.

geoaquacrop_preprocess-0.1.0/PKG-INFO

@@ -0,0 +1,217 @@
+Metadata-Version: 2.4
+Name: geoaquacrop_preprocess
+Version: 0.1.0
+Summary: Automated data download and preprocessing pipeline for running FAO AquaCrop over large regions in gridded format
+Author: Josias Lang-Ritter, Chris Bowden, Seyed Hossein Hosseini, Henrikki Tenkanen, Tim Foster
+Maintainer-email: Josias Lang-Ritter <josias.lang-ritter@aalto.fi>
+License-Expression: Apache-2.0
+Project-URL: Documentation, https://geoaquacrop-preprocess.readthedocs.io/en/stable/
+Project-URL: Homepage, https://github.com/aquacropos/geoaquacrop_preprocess
+Project-URL: Preprocessing, https://github.com/aquacropos/geoaquacrop_preprocess
+Project-URL: Visualization, https://github.com/aquacropos/geoaquacrop_visualize
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: scipy
+Requires-Dist: xarray
+Requires-Dist: dask
+Requires-Dist: shapely
+Requires-Dist: requests
+Requires-Dist: geopandas
+Requires-Dist: rasterio
+Requires-Dist: pandas
+Requires-Dist: cdsapi
+Requires-Dist: netcdf4
+Requires-Dist: rioxarray
+Requires-Dist: owslib
+Requires-Dist: soilgrids
+Requires-Dist: dnspython
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: sphinx>=7; extra == "docs"
+Requires-Dist: furo; extra == "docs"
+Dynamic: license-file
+
+# geoaquacrop_preprocess
+
+> Automated data download and preprocessing pipeline for running AquaCrop-OSPy over large regions in gridded format.
+
+\![Python](https://img.shields.io/badge/python-3.11%2B-blue)
+\![License](https://img.shields.io/badge/license-Apache%20License%202.0-blue)
+
+## Overview
+
+**geoaquacrop_preprocess** prepares all spatial input datasets required to run the [AquaCrop-OSPy](https://github.com/aquacropos/aquacrop) crop water productivity model over large regions (e.g. river basins, countries) in a gridded setup. Given a polygon defining the area of interest and a time period, the pipeline automatically downloads, reprojects, and harmonises the following datasets onto a common output grid:
+
+| Dataset | Variables | Source | Native resolution |
+|---------|-----------|--------|-------------------|
+| Climate (past) | Min/max temperature, precipitation, reference ET | [AgERA5](https://cds.climate.copernicus.eu/datasets/sis-agrometeorological-indicators) via Copernicus CDS | 0.1°, daily |
+| Climate (future) | Min/max temperature, precipitation, reference ET | [NASA NEX-GDDP-CMIP6](https://www.nccs.nasa.gov/services/data-collections/land-based-products/nex-gddp-cmip6) | 0.25°, daily |
+| Soil | Clay, sand, silt, soil organic matter (6 depth layers) | [ISRIC SoilGrids](https://soilgrids.org/) | 250 m |
+| Crop calendar | Planting day of year, growing season length | [GGCMI phase 3 v1.01](https://zenodo.org/records/5062513) | 0.5° |
+| Crop areas | Physical area by crop and irrigation type | [SPAM 2010/2020](https://www.mapspam.info/) | ~10 km |
+
+The climate data source is selected automatically:
+
+- **Past climate** (1979 to last complete year) → AgERA5 reanalysis via the Copernicus CDS API
+- **Future climate** (any year ≥ current year, or before 1979) → NASA NEX-GDDP-CMIP6 projections
+
+All outputs are written as compressed NetCDF files on a shared spatial grid at the user-specified resolution.
+
+## Supported crop types
+
+Barley, Cassava, Cotton, Dry Bean, Maize, Paddy Rice (seasons 1 & 2), Potato, Sorghum, Soybean, Sugar Beet, Sugar Cane, Sunflower, Wheat (summer & winter)
+
+## Prerequisites
+
+- [Miniconda](https://docs.conda.io/en/latest/miniconda.html) or [Anaconda](https://www.anaconda.com/)
+- **For past climate (AgERA5) only:** a free [Copernicus CDS account](https://cds.climate.copernicus.eu/) and your personal API token
+
+## Installation
+
+1. **Clone the repository:**
+   ```bash
+   git clone https://github.com/aquacropos/geoaquacrop_preprocess
+   cd geoaquacrop_preprocess
+   ```
+
+2. **Create and activate the conda environment:**
+   ```bash
+   conda env create -f environment.yml
+   conda activate geoaquacrop
+   ```
+
+## Quick start
+
+### Option A — edit and run the main script
+
+Open `src/geoaquacrop_preprocess/preprocess_main.py`, set the input arguments at the top of the file, and run:
+
+```bash
+conda activate geoaquacrop
+python -m geoaquacrop_preprocess.preprocess_main
+```
+
+Key input arguments:
+
+```python
+workingdirectory = '/path/to/your/output/directory'
+domain_path      = '/path/to/your/domain.geojson'   # polygon in EPSG:4326
+start_year       = 2020
+end_year         = 2022
+cell_resolution  = 0.05   # output grid size in degrees (~3 arcmin)
+api_token        = 'your-copernicus-api-token'       # required for AgERA5 only
+```
+
+For future climate projections (NASA NEX-GDDP-CMIP6), also configure:
+
+```python
+nasanex_model    = 'GFDL-CM4'
+nasanex_scenario = 'ssp245'   # ssp126 | ssp245 | ssp370 | ssp585
+nasanex_ensemble = 'r1i1p1f1'
+```
+
+### Option B — Python API
+
+```python
+from geoaquacrop_preprocess import run
+
+run(
+    domain_shape_path='domain.geojson',
+    start_year=2020,
+    end_year=2022,
+    api_token='your-api-token',       # required for AgERA5 only
+    cell_resolution=0.05,
+    workingdirectory='/path/to/output',
+)
+```
+
+Individual steps can also be run directly, without needing to build a `preprocess` list:
+
+```python
+from geoaquacrop_preprocess import soil, crop_area, crop_calendar, weather
+
+soil(domain_shape_path='domain.geojson', start_year=2020, end_year=2022,
+     workingdirectory='/path/to/output')
+```
+
+## Output files
+
+Processed datasets are written to `<workingdirectory>/processed/`:
+
+| File | Contents |
+|------|----------|
+| `soil_<depth>.nc` | Clay, sand, silt, and soil organic matter for one depth layer |
+| `spam<year>_physical_area.nc` | Crop physical area [ha] per type and irrigation mode |
+| `cropcalendar.nc` | Planting DOY and growing season length per crop and irrigation mode |
+| `MinTemp<years>.nc` | Daily minimum air temperature [°C] |
+| `MaxTemp<years>.nc` | Daily maximum air temperature [°C] |
+| `Precipitation<years>.nc` | Daily precipitation [mm/day] |
+| `ReferenceET<years>.nc` | Daily FAO-56 Penman-Monteith reference ET0 [mm/day] |
+
+Raw downloaded files are kept in `<workingdirectory>/rawdata/` as resumable checkpoints and can be deleted once processing is complete.
+
+## Configuration reference
+
+| Parameter | Default | Description |
+|-----------|---------|-------------|
+| `cell_resolution` | `0.05` | Output grid cell size in decimal degrees |
+| `preprocess` | all steps | Steps to run: `'soil'`, `'crop_areas'`, `'crop_calendar'`, `'climate'` |
+| `nasanex_model` | `'GFDL-CM4'` | CMIP6 model name (see [catalog](https://ds.nccs.nasa.gov/thredds/catalog/AMES/NEX/GDDP-CMIP6/catalog.html)) |
+| `nasanex_scenario` | `'ssp245'` | SSP scenario for years >= 2015 |
+| `nasanex_ensemble` | `'r1i1p1f1'` | Ensemble member identifier |
+
+## Obtaining a Copernicus CDS API token
+
+An API token is required only when processing **past climate data** (AgERA5, 1979 to last complete year):
+
+1. Create a free account at https://cds.climate.copernicus.eu/
+2. Go to **Your profile -> API Token** and copy your token
+3. Accept the dataset terms of use at the [AgERA5 download page](https://cds.climate.copernicus.eu/datasets/sis-agrometeorological-indicators?tab=download)
+
+## License
+
+This project is licensed under the terms described in the [LICENSE](LICENSE) file.
+
+## Data attributions
+
+geoaquacrop_preprocess does not contain any of the datasets listed below. It downloads them from the original providers when you run it, and then reprojects, resamples and harmonises them onto a common grid. If you use the outputs of this tool, please credit the original data providers and follow each provider's terms of use.
+
+### Past climate: AgERA5
+
+Daily past climate data (minimum and maximum temperature, precipitation and reference evapotranspiration) come from AgERA5, produced for the Copernicus Climate Change Service (C3S) and downloaded from the Copernicus Climate Data Store. The data are licensed under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/). Changes made by this tool: regridding and harmonisation.
+
+> Contains modified Copernicus Climate Change Service information 2026. Neither the European Commission nor ECMWF is responsible for any use that may be made of this information.
+
+Boogaard, H., Schubert, J., De Wit, A., Lazebnik, J., Hutjes, R., Van der Grijn, G. (2020): Agrometeorological indicators from 1979 to present derived from reanalysis. Copernicus Climate Change Service (C3S) Climate Data Store (CDS). DOI: [10.24381/cds.6c68c9bb](https://doi.org/10.24381/cds.6c68c9bb) (accessed on DD-MMM-YYYY).
+
+### Future climate: NASA NEX-GDDP-CMIP6
+
+Future climate projections come from the NASA Earth Exchange Global Daily Downscaled Projections (NEX-GDDP-CMIP6). The dataset was prepared by the Climate Analytics Group and the NASA Ames Research Center using the NASA Earth Exchange, and is distributed by the NASA Center for Climate Simulation (NCCS). We thank the World Climate Research Programme and its Working Group on Coupled Modelling, which coordinated CMIP6. We also thank the climate modelling groups who produced and shared their model output, the Earth System Grid Federation (ESGF) for archiving and providing access, and the agencies that fund CMIP6 and ESGF. The underlying CMIP6 model output is subject to the [CMIP6 terms of use](https://pcmdi.llnl.gov/CMIP6/TermsOfUse/TermsOfUse6-1.html).
+
+- Thrasher, B., Wang, W., Michaelis, A., Melton, F., Lee, T., Nemani, R. (2022): NASA Global Daily Downscaled Projections, CMIP6. Scientific Data 9, 262. [https://doi.org/10.1038/s41597-022-01393-4](https://doi.org/10.1038/s41597-022-01393-4)
+- Thrasher, B., Wang, W., Michaelis, A., Nemani, R. (2021): NEX-GDDP-CMIP6. NASA Center for Climate Simulation. [https://doi.org/10.7917/OFSG3345](https://doi.org/10.7917/OFSG3345)
+
+### Soil: ISRIC SoilGrids
+
+Soil texture and organic matter data come from SoilGrids 2.0, produced by ISRIC – World Soil Information and licensed under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/). Changes made by this tool: clipping, resampling and harmonisation.
+
+Poggio, L., de Sousa, L. M., Batjes, N. H., Heuvelink, G. B. M., Kempen, B., Ribeiro, E., Rossiter, D. (2021): SoilGrids 2.0: producing soil information for the globe with quantified spatial uncertainty. SOIL 7, 217–240. [https://doi.org/10.5194/soil-7-217-2021](https://doi.org/10.5194/soil-7-217-2021)
+
+### Crop calendar: GGCMI Phase 3
+
+Planting dates and growing season lengths come from the GGCMI Phase 3 crop calendar (v1.01), licensed under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/). Changes made by this tool: regridding and conversion to AquaCrop inputs.
+
+- Jägermeyr, J., Müller, C., Minoli, S., Ray, D., Siebert, S. (2021): GGCMI Phase 3 crop calendar (v1.01) [Data set]. Zenodo. [https://doi.org/10.5281/zenodo.5062513](https://doi.org/10.5281/zenodo.5062513)
+- Jägermeyr, J., Müller, C., Ruane, A. C. et al. (2021): Climate impacts on global agriculture emerge earlier in new generation of climate and crop models. Nature Food 2, 873–885. [https://doi.org/10.1038/s43016-021-00400-y](https://doi.org/10.1038/s43016-021-00400-y)
+
+### Crop areas: SPAM (MapSPAM)
+
+Physical crop areas come from the Spatial Production Allocation Model (SPAM), developed by the International Food Policy Research Institute (IFPRI) and partners. Please check the licence of the SPAM version you use on its Harvard Dataverse page. The MapSPAM terms of use refer to a [CC BY-NC 3.0](https://creativecommons.org/licenses/by-nc/3.0/) licence, which does not allow commercial use.
+
+- SPAM 2020: International Food Policy Research Institute (IFPRI), 2026, "Global Spatially-Disaggregated Crop Production Statistics Data for 2020 Version 2.0 Release 2", [https://doi.org/10.7910/DVN/SWPENT](https://doi.org/10.7910/DVN/SWPENT), Harvard Dataverse, V5
+- SPAM 2010: International Food Policy Research Institute, 2019, "Global Spatially-Disaggregated Crop Production Statistics Data for 2010 Version 2.0", [https://doi.org/10.7910/DVN/PRFF8V](https://doi.org/10.7910/DVN/PRFF8V), Harvard Dataverse, V4
+- Yu, Q., You, L., Wood-Sichra, U., Ru, Y., Joglekar, A. K. B., Fritz, S., Xiong, W., Lu, M., Wu, W., Yang, P. (2020): A cultivated planet in 2010 – Part 2: The global gridded agricultural-production maps. Earth System Science Data 12, 3545–3572. [https://doi.org/10.5194/essd-12-3545-2020](https://doi.org/10.5194/essd-12-3545-2020)

geoaquacrop_preprocess-0.1.0/README.md

@@ -0,0 +1,180 @@
+# geoaquacrop_preprocess
+
+> Automated data download and preprocessing pipeline for running AquaCrop-OSPy over large regions in gridded format.
+
+\![Python](https://img.shields.io/badge/python-3.11%2B-blue)
+\![License](https://img.shields.io/badge/license-Apache%20License%202.0-blue)
+
+## Overview
+
+**geoaquacrop_preprocess** prepares all spatial input datasets required to run the [AquaCrop-OSPy](https://github.com/aquacropos/aquacrop) crop water productivity model over large regions (e.g. river basins, countries) in a gridded setup. Given a polygon defining the area of interest and a time period, the pipeline automatically downloads, reprojects, and harmonises the following datasets onto a common output grid:
+
+| Dataset | Variables | Source | Native resolution |
+|---------|-----------|--------|-------------------|
+| Climate (past) | Min/max temperature, precipitation, reference ET | [AgERA5](https://cds.climate.copernicus.eu/datasets/sis-agrometeorological-indicators) via Copernicus CDS | 0.1°, daily |
+| Climate (future) | Min/max temperature, precipitation, reference ET | [NASA NEX-GDDP-CMIP6](https://www.nccs.nasa.gov/services/data-collections/land-based-products/nex-gddp-cmip6) | 0.25°, daily |
+| Soil | Clay, sand, silt, soil organic matter (6 depth layers) | [ISRIC SoilGrids](https://soilgrids.org/) | 250 m |
+| Crop calendar | Planting day of year, growing season length | [GGCMI phase 3 v1.01](https://zenodo.org/records/5062513) | 0.5° |
+| Crop areas | Physical area by crop and irrigation type | [SPAM 2010/2020](https://www.mapspam.info/) | ~10 km |
+
+The climate data source is selected automatically:
+
+- **Past climate** (1979 to last complete year) → AgERA5 reanalysis via the Copernicus CDS API
+- **Future climate** (any year ≥ current year, or before 1979) → NASA NEX-GDDP-CMIP6 projections
+
+All outputs are written as compressed NetCDF files on a shared spatial grid at the user-specified resolution.
+
+## Supported crop types
+
+Barley, Cassava, Cotton, Dry Bean, Maize, Paddy Rice (seasons 1 & 2), Potato, Sorghum, Soybean, Sugar Beet, Sugar Cane, Sunflower, Wheat (summer & winter)
+
+## Prerequisites
+
+- [Miniconda](https://docs.conda.io/en/latest/miniconda.html) or [Anaconda](https://www.anaconda.com/)
+- **For past climate (AgERA5) only:** a free [Copernicus CDS account](https://cds.climate.copernicus.eu/) and your personal API token
+
+## Installation
+
+1. **Clone the repository:**
+   ```bash
+   git clone https://github.com/aquacropos/geoaquacrop_preprocess
+   cd geoaquacrop_preprocess
+   ```
+
+2. **Create and activate the conda environment:**
+   ```bash
+   conda env create -f environment.yml
+   conda activate geoaquacrop
+   ```
+
+## Quick start
+
+### Option A — edit and run the main script
+
+Open `src/geoaquacrop_preprocess/preprocess_main.py`, set the input arguments at the top of the file, and run:
+
+```bash
+conda activate geoaquacrop
+python -m geoaquacrop_preprocess.preprocess_main
+```
+
+Key input arguments:
+
+```python
+workingdirectory = '/path/to/your/output/directory'
+domain_path      = '/path/to/your/domain.geojson'   # polygon in EPSG:4326
+start_year       = 2020
+end_year         = 2022
+cell_resolution  = 0.05   # output grid size in degrees (~3 arcmin)
+api_token        = 'your-copernicus-api-token'       # required for AgERA5 only
+```
+
+For future climate projections (NASA NEX-GDDP-CMIP6), also configure:
+
+```python
+nasanex_model    = 'GFDL-CM4'
+nasanex_scenario = 'ssp245'   # ssp126 | ssp245 | ssp370 | ssp585
+nasanex_ensemble = 'r1i1p1f1'
+```
+
+### Option B — Python API
+
+```python
+from geoaquacrop_preprocess import run
+
+run(
+    domain_shape_path='domain.geojson',
+    start_year=2020,
+    end_year=2022,
+    api_token='your-api-token',       # required for AgERA5 only
+    cell_resolution=0.05,
+    workingdirectory='/path/to/output',
+)
+```
+
+Individual steps can also be run directly, without needing to build a `preprocess` list:
+
+```python
+from geoaquacrop_preprocess import soil, crop_area, crop_calendar, weather
+
+soil(domain_shape_path='domain.geojson', start_year=2020, end_year=2022,
+     workingdirectory='/path/to/output')
+```
+
+## Output files
+
+Processed datasets are written to `<workingdirectory>/processed/`:
+
+| File | Contents |
+|------|----------|
+| `soil_<depth>.nc` | Clay, sand, silt, and soil organic matter for one depth layer |
+| `spam<year>_physical_area.nc` | Crop physical area [ha] per type and irrigation mode |
+| `cropcalendar.nc` | Planting DOY and growing season length per crop and irrigation mode |
+| `MinTemp<years>.nc` | Daily minimum air temperature [°C] |
+| `MaxTemp<years>.nc` | Daily maximum air temperature [°C] |
+| `Precipitation<years>.nc` | Daily precipitation [mm/day] |
+| `ReferenceET<years>.nc` | Daily FAO-56 Penman-Monteith reference ET0 [mm/day] |
+
+Raw downloaded files are kept in `<workingdirectory>/rawdata/` as resumable checkpoints and can be deleted once processing is complete.
+
+## Configuration reference
+
+| Parameter | Default | Description |
+|-----------|---------|-------------|
+| `cell_resolution` | `0.05` | Output grid cell size in decimal degrees |
+| `preprocess` | all steps | Steps to run: `'soil'`, `'crop_areas'`, `'crop_calendar'`, `'climate'` |
+| `nasanex_model` | `'GFDL-CM4'` | CMIP6 model name (see [catalog](https://ds.nccs.nasa.gov/thredds/catalog/AMES/NEX/GDDP-CMIP6/catalog.html)) |
+| `nasanex_scenario` | `'ssp245'` | SSP scenario for years >= 2015 |
+| `nasanex_ensemble` | `'r1i1p1f1'` | Ensemble member identifier |
+
+## Obtaining a Copernicus CDS API token
+
+An API token is required only when processing **past climate data** (AgERA5, 1979 to last complete year):
+
+1. Create a free account at https://cds.climate.copernicus.eu/
+2. Go to **Your profile -> API Token** and copy your token
+3. Accept the dataset terms of use at the [AgERA5 download page](https://cds.climate.copernicus.eu/datasets/sis-agrometeorological-indicators?tab=download)
+
+## License
+
+This project is licensed under the terms described in the [LICENSE](LICENSE) file.
+
+## Data attributions
+
+geoaquacrop_preprocess does not contain any of the datasets listed below. It downloads them from the original providers when you run it, and then reprojects, resamples and harmonises them onto a common grid. If you use the outputs of this tool, please credit the original data providers and follow each provider's terms of use.
+
+### Past climate: AgERA5
+
+Daily past climate data (minimum and maximum temperature, precipitation and reference evapotranspiration) come from AgERA5, produced for the Copernicus Climate Change Service (C3S) and downloaded from the Copernicus Climate Data Store. The data are licensed under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/). Changes made by this tool: regridding and harmonisation.
+
+> Contains modified Copernicus Climate Change Service information 2026. Neither the European Commission nor ECMWF is responsible for any use that may be made of this information.
+
+Boogaard, H., Schubert, J., De Wit, A., Lazebnik, J., Hutjes, R., Van der Grijn, G. (2020): Agrometeorological indicators from 1979 to present derived from reanalysis. Copernicus Climate Change Service (C3S) Climate Data Store (CDS). DOI: [10.24381/cds.6c68c9bb](https://doi.org/10.24381/cds.6c68c9bb) (accessed on DD-MMM-YYYY).
+
+### Future climate: NASA NEX-GDDP-CMIP6
+
+Future climate projections come from the NASA Earth Exchange Global Daily Downscaled Projections (NEX-GDDP-CMIP6). The dataset was prepared by the Climate Analytics Group and the NASA Ames Research Center using the NASA Earth Exchange, and is distributed by the NASA Center for Climate Simulation (NCCS). We thank the World Climate Research Programme and its Working Group on Coupled Modelling, which coordinated CMIP6. We also thank the climate modelling groups who produced and shared their model output, the Earth System Grid Federation (ESGF) for archiving and providing access, and the agencies that fund CMIP6 and ESGF. The underlying CMIP6 model output is subject to the [CMIP6 terms of use](https://pcmdi.llnl.gov/CMIP6/TermsOfUse/TermsOfUse6-1.html).
+
+- Thrasher, B., Wang, W., Michaelis, A., Melton, F., Lee, T., Nemani, R. (2022): NASA Global Daily Downscaled Projections, CMIP6. Scientific Data 9, 262. [https://doi.org/10.1038/s41597-022-01393-4](https://doi.org/10.1038/s41597-022-01393-4)
+- Thrasher, B., Wang, W., Michaelis, A., Nemani, R. (2021): NEX-GDDP-CMIP6. NASA Center for Climate Simulation. [https://doi.org/10.7917/OFSG3345](https://doi.org/10.7917/OFSG3345)
+
+### Soil: ISRIC SoilGrids
+
+Soil texture and organic matter data come from SoilGrids 2.0, produced by ISRIC – World Soil Information and licensed under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/). Changes made by this tool: clipping, resampling and harmonisation.
+
+Poggio, L., de Sousa, L. M., Batjes, N. H., Heuvelink, G. B. M., Kempen, B., Ribeiro, E., Rossiter, D. (2021): SoilGrids 2.0: producing soil information for the globe with quantified spatial uncertainty. SOIL 7, 217–240. [https://doi.org/10.5194/soil-7-217-2021](https://doi.org/10.5194/soil-7-217-2021)
+
+### Crop calendar: GGCMI Phase 3
+
+Planting dates and growing season lengths come from the GGCMI Phase 3 crop calendar (v1.01), licensed under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/). Changes made by this tool: regridding and conversion to AquaCrop inputs.
+
+- Jägermeyr, J., Müller, C., Minoli, S., Ray, D., Siebert, S. (2021): GGCMI Phase 3 crop calendar (v1.01) [Data set]. Zenodo. [https://doi.org/10.5281/zenodo.5062513](https://doi.org/10.5281/zenodo.5062513)
+- Jägermeyr, J., Müller, C., Ruane, A. C. et al. (2021): Climate impacts on global agriculture emerge earlier in new generation of climate and crop models. Nature Food 2, 873–885. [https://doi.org/10.1038/s43016-021-00400-y](https://doi.org/10.1038/s43016-021-00400-y)
+
+### Crop areas: SPAM (MapSPAM)
+
+Physical crop areas come from the Spatial Production Allocation Model (SPAM), developed by the International Food Policy Research Institute (IFPRI) and partners. Please check the licence of the SPAM version you use on its Harvard Dataverse page. The MapSPAM terms of use refer to a [CC BY-NC 3.0](https://creativecommons.org/licenses/by-nc/3.0/) licence, which does not allow commercial use.
+
+- SPAM 2020: International Food Policy Research Institute (IFPRI), 2026, "Global Spatially-Disaggregated Crop Production Statistics Data for 2020 Version 2.0 Release 2", [https://doi.org/10.7910/DVN/SWPENT](https://doi.org/10.7910/DVN/SWPENT), Harvard Dataverse, V5
+- SPAM 2010: International Food Policy Research Institute, 2019, "Global Spatially-Disaggregated Crop Production Statistics Data for 2010 Version 2.0", [https://doi.org/10.7910/DVN/PRFF8V](https://doi.org/10.7910/DVN/PRFF8V), Harvard Dataverse, V4
+- Yu, Q., You, L., Wood-Sichra, U., Ru, Y., Joglekar, A. K. B., Fritz, S., Xiong, W., Lu, M., Wu, W., Yang, P. (2020): A cultivated planet in 2010 – Part 2: The global gridded agricultural-production maps. Earth System Science Data 12, 3545–3572. [https://doi.org/10.5194/essd-12-3545-2020](https://doi.org/10.5194/essd-12-3545-2020)