geoaquacrop 0.1.0__tar.gz

geoaquacrop-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-0.1.0/PKG-INFO

@@ -0,0 +1,172 @@
+Metadata-Version: 2.4
+Name: geoaquacrop
+Version: 0.1.0
+Summary: Unified entry point to the GeoAquaCrop toolchain: preprocessing, gridded simulation, and visualisation
+Author: Josias Lang-Ritter, Chris Bowden, Seyed Hossein Hosseini, Henrikki Tenkanen, Tim Foster
+Maintainer-email: Josias Lang-Ritter <josias.lang-ritter@aalto.fi>, Chris Bowden <christopher.bowden@manchester.ac.uk>, Seyed Hossein Hosseini <seyed.h.hosseini@aalto.fi>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/aquacropos/geoaquacrop
+Project-URL: Documentation, https://geoaquacrop.readthedocs.io
+Project-URL: Preprocessing, https://github.com/aquacropos/geoaquacrop_preprocess
+Project-URL: Simulation, https://github.com/aquacropos/geoaquacrop_simulate
+Project-URL: Visualization, https://github.com/aquacropos/geoaquacrop_visualize
+Keywords: aquacrop,crop model,water productivity,gridded,agriculture
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Scientific/Engineering :: Hydrology
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: geoaquacrop_preprocess>=0.1
+Requires-Dist: geoaquacrop_simulate>=0.1
+Requires-Dist: geoaquacrop_visualize>=0.1
+Provides-Extra: docs
+Requires-Dist: sphinx>=7; extra == "docs"
+Requires-Dist: furo; extra == "docs"
+Dynamic: license-file
+
+# GeoAquaCrop
+
+> Run AquaCrop-OSPy over large regions in gridded format — from raw global datasets to interactive results.
+
+![Python](https://img.shields.io/badge/python-3.11%2B-blue) ![License](https://img.shields.io/badge/license-Apache%20License%202.0-blue)
+
+## One import, three stages
+
+```python
+import geoaquacrop as gac
+
+gac.preprocess.run(...)        # download & harmonise the input datasets
+gac.simulate.run(...)          # run AquaCrop for every grid cell
+gac.visualize.run()         # explore the results
+```
+
+That is the whole API. Each stage is a separately maintained package, but you
+never need to know their names: `geoaquacrop` presents them as one library.
+
+```
+gac.preprocess  ->  gac.simulate  ->  gac.visualize
+```
+
+| Stage | What it does | Documentation |
+| ----- | ------------ | ------------- |
+| `gac.preprocess` | Downloads and harmonises climate, soil, crop calendar and crop area data onto a common grid for a given polygon and period | [readthedocs](https://geoaquacrop-preprocessing.readthedocs.io/en/stable/) |
+| `gac.simulate` | Runs AquaCrop per grid cell in parallel; optional yield bias-correction and calibration against observations | [readthedocs](https://geoaquacrop-simulate.readthedocs.io) |
+| `gac.visualize` | Interactive Dash/Plotly dashboard for exploring simulation outputs and climate inputs | [readthedocs](https://geoaquacrop-visualize.readthedocs.io/en/latest/) |
+
+## Installation
+
+```bash
+conda create -n geoaquacrop python=3.11
+conda activate geoaquacrop
+python -m pip install --pre geoaquacrop
+```
+
+The `--pre` flag is needed while the toolchain is in beta (`0.1.0b1`); pip skips
+pre-release versions otherwise. This installs all three stages.
+
+**For past climate data** you also need a free [Copernicus CDS account](https://cds.climate.copernicus.eu/)
+and API token — see the preprocessing documentation.
+
+<details>
+<summary>Installing a single stage</summary>
+
+Each stage also works standalone, with the same function names:
+
+```bash
+python -m pip install geoaquacrop_preprocess    # data preparation only
+python -m pip install geoaquacrop_simulate      # simulation only
+python -m pip install geoaquacrop_visualize     # visualisation only
+```
+
+```python
+import geoaquacrop_simulate as simulate
+summary_file, daily_file = simulate.run(data_path='...', start_date='...',
+                                        end_date='...', crop='Wheat_winter')
+```
+
+`gac.simulate.run` and `geoaquacrop_simulate.run` are the same function, so
+code written against either keeps working.
+</details>
+
+## End-to-end example
+
+A complete run for one region, using only `gac`.
+
+```python
+import geoaquacrop as gac
+
+# 1. prepare the input data
+gac.preprocess.run(
+    domain_shape_path='high_plains.geojson',   # polygon, EPSG:4326
+    start_year=2011,
+    end_year=2013,
+    api_token='your-copernicus-api-token',
+    cell_resolution=0.05,
+    workingdirectory='/data/high_plains',
+)
+
+# 2. run the simulation
+summary_file, daily_file = gac.simulate.run(
+    data_path='/data/high_plains/processed',   # fills all four input paths
+    start_date='2011/01/01',
+    end_date='2013/12/31',
+    crop='Wheat_winter',
+    irrigation='rainfed',
+    output_dir='outputs',
+)
+
+# 3. explore the results
+gac.visualize.run()          # then open http://localhost:8050
+```
+
+## What each stage offers
+
+```python
+gac.preprocess.run(...)                 # prepare every dataset
+gac.preprocess.weather(...)             # or re-run a single step
+gac.preprocess.soil(...)
+gac.preprocess.crop_calendar(...)
+gac.preprocess.crop_area(...)
+
+gac.simulate.run(data_path=..., ...)    # simulate; returns (summary, daily)
+gac.simulate.example_config()           # inspect every available setting
+gac.simulate.input_requirements()       # print required files and units
+gac.simulate.build_reference(...)       # per-year, region-level yield reference
+gac.simulate.correct(config)            # bias-correct a saved run, no re-run
+gac.simulate.compare([...])             # comparison figures and statistics
+gac.simulate.load_results(path)         # saved results as tidy per-year points
+
+gac.visualize.run()                  # start the dashboard
+```
+
+Importing `geoaquacrop` is cheap: each stage — and its dependencies — loads only
+when you first use it. If a stage is not installed, calling it tells you exactly
+what to install.
+
+## Which stage do I need?
+
+- **Model outputs for a region, starting from nothing** — all three.
+- **Already have gridded climate, soil and crop inputs** — `gac.simulate` alone.
+- **Already have simulation outputs** — `gac.visualize` alone.
+
+## Documentation
+
+- **This toolchain** — <https://geoaquacrop.readthedocs.io>
+- **Preprocessing** — <https://geoaquacrop-preprocessing.readthedocs.io/en/stable/>
+- **Simulation** — <https://geoaquacrop-simulate.readthedocs.io>
+- **Visualisation** — <https://geoaquacrop-visualize.readthedocs.io/en/latest/>
+
+Contributors: see [the stage package standard](https://geoaquacrop.readthedocs.io/en/latest/standard.html)
+for the naming and API contract each stage follows.
+
+## Citation
+
+If you use GeoAquaCrop in published work, please cite the toolchain and the
+underlying [AquaCrop-OSPy](https://github.com/aquacropos/aquacrop) model.
+
+## License
+
+Apache-2.0 — see [LICENSE](LICENSE).

geoaquacrop-0.1.0/README.md

@@ -0,0 +1,143 @@
+# GeoAquaCrop
+
+> Run AquaCrop-OSPy over large regions in gridded format — from raw global datasets to interactive results.
+
+![Python](https://img.shields.io/badge/python-3.11%2B-blue) ![License](https://img.shields.io/badge/license-Apache%20License%202.0-blue)
+
+## One import, three stages
+
+```python
+import geoaquacrop as gac
+
+gac.preprocess.run(...)        # download & harmonise the input datasets
+gac.simulate.run(...)          # run AquaCrop for every grid cell
+gac.visualize.run()         # explore the results
+```
+
+That is the whole API. Each stage is a separately maintained package, but you
+never need to know their names: `geoaquacrop` presents them as one library.
+
+```
+gac.preprocess  ->  gac.simulate  ->  gac.visualize
+```
+
+| Stage | What it does | Documentation |
+| ----- | ------------ | ------------- |
+| `gac.preprocess` | Downloads and harmonises climate, soil, crop calendar and crop area data onto a common grid for a given polygon and period | [readthedocs](https://geoaquacrop-preprocessing.readthedocs.io/en/stable/) |
+| `gac.simulate` | Runs AquaCrop per grid cell in parallel; optional yield bias-correction and calibration against observations | [readthedocs](https://geoaquacrop-simulate.readthedocs.io) |
+| `gac.visualize` | Interactive Dash/Plotly dashboard for exploring simulation outputs and climate inputs | [readthedocs](https://geoaquacrop-visualize.readthedocs.io/en/latest/) |
+
+## Installation
+
+```bash
+conda create -n geoaquacrop python=3.11
+conda activate geoaquacrop
+python -m pip install --pre geoaquacrop
+```
+
+The `--pre` flag is needed while the toolchain is in beta (`0.1.0b1`); pip skips
+pre-release versions otherwise. This installs all three stages.
+
+**For past climate data** you also need a free [Copernicus CDS account](https://cds.climate.copernicus.eu/)
+and API token — see the preprocessing documentation.
+
+<details>
+<summary>Installing a single stage</summary>
+
+Each stage also works standalone, with the same function names:
+
+```bash
+python -m pip install geoaquacrop_preprocess    # data preparation only
+python -m pip install geoaquacrop_simulate      # simulation only
+python -m pip install geoaquacrop_visualize     # visualisation only
+```
+
+```python
+import geoaquacrop_simulate as simulate
+summary_file, daily_file = simulate.run(data_path='...', start_date='...',
+                                        end_date='...', crop='Wheat_winter')
+```
+
+`gac.simulate.run` and `geoaquacrop_simulate.run` are the same function, so
+code written against either keeps working.
+</details>
+
+## End-to-end example
+
+A complete run for one region, using only `gac`.
+
+```python
+import geoaquacrop as gac
+
+# 1. prepare the input data
+gac.preprocess.run(
+    domain_shape_path='high_plains.geojson',   # polygon, EPSG:4326
+    start_year=2011,
+    end_year=2013,
+    api_token='your-copernicus-api-token',
+    cell_resolution=0.05,
+    workingdirectory='/data/high_plains',
+)
+
+# 2. run the simulation
+summary_file, daily_file = gac.simulate.run(
+    data_path='/data/high_plains/processed',   # fills all four input paths
+    start_date='2011/01/01',
+    end_date='2013/12/31',
+    crop='Wheat_winter',
+    irrigation='rainfed',
+    output_dir='outputs',
+)
+
+# 3. explore the results
+gac.visualize.run()          # then open http://localhost:8050
+```
+
+## What each stage offers
+
+```python
+gac.preprocess.run(...)                 # prepare every dataset
+gac.preprocess.weather(...)             # or re-run a single step
+gac.preprocess.soil(...)
+gac.preprocess.crop_calendar(...)
+gac.preprocess.crop_area(...)
+
+gac.simulate.run(data_path=..., ...)    # simulate; returns (summary, daily)
+gac.simulate.example_config()           # inspect every available setting
+gac.simulate.input_requirements()       # print required files and units
+gac.simulate.build_reference(...)       # per-year, region-level yield reference
+gac.simulate.correct(config)            # bias-correct a saved run, no re-run
+gac.simulate.compare([...])             # comparison figures and statistics
+gac.simulate.load_results(path)         # saved results as tidy per-year points
+
+gac.visualize.run()                  # start the dashboard
+```
+
+Importing `geoaquacrop` is cheap: each stage — and its dependencies — loads only
+when you first use it. If a stage is not installed, calling it tells you exactly
+what to install.
+
+## Which stage do I need?
+
+- **Model outputs for a region, starting from nothing** — all three.
+- **Already have gridded climate, soil and crop inputs** — `gac.simulate` alone.
+- **Already have simulation outputs** — `gac.visualize` alone.
+
+## Documentation
+
+- **This toolchain** — <https://geoaquacrop.readthedocs.io>
+- **Preprocessing** — <https://geoaquacrop-preprocessing.readthedocs.io/en/stable/>
+- **Simulation** — <https://geoaquacrop-simulate.readthedocs.io>
+- **Visualisation** — <https://geoaquacrop-visualize.readthedocs.io/en/latest/>
+
+Contributors: see [the stage package standard](https://geoaquacrop.readthedocs.io/en/latest/standard.html)
+for the naming and API contract each stage follows.
+
+## Citation
+
+If you use GeoAquaCrop in published work, please cite the toolchain and the
+underlying [AquaCrop-OSPy](https://github.com/aquacropos/aquacrop) model.
+
+## License
+
+Apache-2.0 — see [LICENSE](LICENSE).

geoaquacrop-0.1.0/pyproject.toml

@@ -0,0 +1,56 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "geoaquacrop"
+version = "0.1.0"
+description = "Unified entry point to the GeoAquaCrop toolchain: preprocessing, gridded simulation, and visualisation"
+readme = "README.md"
+requires-python = ">=3.11"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [
+    { name = "Josias Lang-Ritter" },
+    { name = "Chris Bowden" },
+    { name = "Seyed Hossein Hosseini" },
+    { name = "Henrikki Tenkanen" },
+    { name = "Tim Foster" },
+    ]
+maintainers = [
+    { name = "Josias Lang-Ritter", email = "josias.lang-ritter@aalto.fi" },
+    { name = "Chris Bowden", email = "christopher.bowden@manchester.ac.uk" },
+    { name = "Seyed Hossein Hosseini", email = "seyed.h.hosseini@aalto.fi" },
+]
+keywords = ["aquacrop", "crop model", "water productivity", "gridded", "agriculture"]
+
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Science/Research",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Topic :: Scientific/Engineering :: Hydrology",
+]
+
+# The meta-package installs the three components. Version floors only, so each
+# can be released independently without a coordinated bump here.
+dependencies = [
+    "geoaquacrop_preprocess>=0.1",
+    "geoaquacrop_simulate>=0.1",
+    "geoaquacrop_visualize>=0.1",
+]
+
+[project.optional-dependencies]
+docs = ["sphinx>=7", "furo"]
+
+[project.urls]
+Homepage = "https://github.com/aquacropos/geoaquacrop"
+Documentation = "https://geoaquacrop.readthedocs.io"
+Preprocessing = "https://github.com/aquacropos/geoaquacrop_preprocess"
+Simulation = "https://github.com/aquacropos/geoaquacrop_simulate"
+Visualization = "https://github.com/aquacropos/geoaquacrop_visualize"
+
+# The umbrella ships the `geoaquacrop` façade package (a thin, lazily-imported
+# wrapper over the three stage packages) plus the dependency metadata.
+[tool.setuptools.packages.find]
+where = ["src"]

geoaquacrop-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

geoaquacrop-0.1.0/src/geoaquacrop/__init__.py

@@ -0,0 +1,38 @@
+"""GeoAquaCrop — gridded FAO AquaCrop from raw data to results.
+
+A single, stable entry point to the three toolchain packages::
+
+    import geoaquacrop as gac
+
+    gac.preprocess.run(...)      # download & harmonise input datasets
+    gac.simulate.run(config)          # simulate every grid cell
+    gac.visualize.run(...)          # explore the results
+
+Each stage is also installable and usable on its own
+(``geoaquacrop_preprocess``, ``geoaquacrop_simulate``, ``geoaquacrop_visualize``);
+this package is a thin, curated façade over them, so the names here stay
+stable even if the internals move.
+
+Submodules are imported lazily: ``import geoaquacrop`` is cheap, and the heavy
+dependencies of a stage are only loaded when you first touch that stage.
+"""
+from importlib import import_module as _import_module
+
+__all__ = ["preprocess", "simulate", "visualize"]
+__version__ = "0.1.0b1"
+
+_SUBMODULES = frozenset(__all__)
+
+
+def __getattr__(name):
+    """Import a stage on first use (PEP 562)."""
+    if name in _SUBMODULES:
+        module = _import_module(f"{__name__}.{name}")
+        globals()[name] = module
+        return module
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
+
+
+def __dir__():
+    public = [k for k in globals() if not k.startswith("_")]
+    return sorted(set(public) | _SUBMODULES)

geoaquacrop-0.1.0/src/geoaquacrop/_util.py

@@ -0,0 +1,87 @@
+"""Shared helper for the stage façades."""
+from importlib import import_module
+
+# stage -> (distribution name, import name, purpose)
+
+STAGES = {
+    "preprocess": {
+        "distribution": "geoaquacrop_preprocess",
+        "module": "geoaquacrop_preprocess",
+        "purpose": "input data preparation",
+    },
+    "simulate": {
+        "distribution": "geoaquacrop_simulate",
+        "module": "geoaquacrop_simulate",
+        "purpose": "gridded simulation",
+    },
+    "visualize": {
+        "distribution": "geoaquacrop_visualize",
+        "module": "geoaquacrop_visualize",
+        "purpose": "result visualisation",
+    },
+}
+
+
+def require(stage):
+    """Import the package behind a stage, or explain how to install it.
+
+    Parameters
+    ----------
+    stage : str
+        One of ``"preprocess"``, ``"simulate"``, ``"visualize"``.
+
+    Returns
+    -------
+    module
+        The imported stage package.
+
+    Raises
+    ------
+    ImportError
+        If the stage is not installed, with the command needed to install it.
+    """
+    spec = STAGES[stage]
+    try:
+        return import_module(spec["module"])
+    except ImportError as exc:
+        raise ImportError(
+            f"{spec['distribution']} is required for {spec['purpose']} but is "
+            f"not installed.\n"
+            f"    python -m pip install {spec['distribution']}\n"
+            f"or install the whole toolchain with:\n"
+            f"    python -m pip install geoaquacrop"
+        ) from exc
+
+
+def delegate(stage, name):
+    """Return the callable a stage package exports under ``name``.
+
+    Stage packages export their public API at package level (see the stage
+    standard), so the façade looks up exactly one name and fails loudly if it
+    is absent or not callable.
+
+    Parameters
+    ----------
+    stage : str
+        One of ``"preprocess"``, ``"simulate"``, ``"visualize"``.
+    name : str
+        The attribute to fetch from that stage package.
+
+    Returns
+    -------
+    callable
+
+    Raises
+    ------
+    AttributeError
+        If the stage package does not export ``name`` as a callable.
+    """
+    pkg = require(stage)
+    fn = getattr(pkg, name, None)
+    if not callable(fn):
+        exported = ", ".join(sorted(getattr(pkg, "__all__", []))) or "nothing"
+        raise AttributeError(
+            f"{pkg.__name__} does not export a callable {name!r}. "
+            f"It exports: {exported}. See the GeoAquaCrop stage standard."
+        )
+    return fn

geoaquacrop-0.1.0/src/geoaquacrop/preprocess.py

@@ -0,0 +1,44 @@
+"""Input data preparation — :mod:`geoaquacrop.preprocess`.
+
+Façade over the ``geoaquacrop_preprocess`` package::
+
+    import geoaquacrop as gac
+
+    gac.preprocess.run(domain_shape_path='region.geojson', start_year=2011,
+                       end_year=2013, api_token='...', cell_resolution=0.05,
+                       workingdirectory='/data/region')
+
+:func:`run` prepares every dataset a simulation needs. The per-dataset helpers
+re-run a single step; each requires the stage package to export that step at
+package level (see the stage standard), and raises an explicit error if the
+installed version does not.
+"""
+from ._util import delegate
+
+__all__ = ["run", "weather", "soil", "crop_calendar", "crop_area"]
+
+
+def run(*args, **kwargs):
+    """Download and harmonise every input dataset for a domain and period."""
+    return delegate("preprocess", "run")(
+        *args, **kwargs)
+
+
+def weather(*args, **kwargs):
+    """Prepare the climate inputs only."""
+    return delegate("preprocess", "weather")(*args, **kwargs)
+
+
+def soil(*args, **kwargs):
+    """Prepare the soil inputs only."""
+    return delegate("preprocess", "soil")(*args, **kwargs)
+
+
+def crop_calendar(*args, **kwargs):
+    """Prepare the crop calendar (planting day, season length) only."""
+    return delegate("preprocess", "crop_calendar")(*args, **kwargs)
+
+
+def crop_area(*args, **kwargs):
+    """Prepare the crop area mask only."""
+    return delegate("preprocess", "crop_area")(*args, **kwargs)

geoaquacrop-0.1.0/src/geoaquacrop/simulate.py

@@ -0,0 +1,85 @@
+"""Gridded AquaCrop simulation — :mod:`geoaquacrop.simulate`.
+
+Façade over the ``geoaquacrop_simulate`` package::
+
+    import geoaquacrop as gac
+
+    summary_file, daily_file = gac.simulate.run(
+        data_path='/data/region/processed',
+        start_date='2011/01/01', end_date='2013/12/31',
+        crop='Wheat_winter', irrigation='rainfed')
+
+Every name here is re-exported from ``geoaquacrop_simulate``; the two are
+interchangeable, so code written against either keeps working.
+"""
+from ._util import delegate, require
+
+__all__ = ["run", "example_config", "input_requirements", "build_reference",
+           "correct", "compare", "load_results"]
+
+
+def run(config=None, **kwargs):
+    """Run a simulation for every cell in the domain.
+
+    Settings are given as keyword arguments::
+
+        gac.simulate.run(data_path='/data/region/processed',
+                         start_date='2011/01/01', end_date='2013/12/31',
+                         crop='Wheat_winter', irrigation='rainfed')
+
+    ``data_path`` fills all four input paths at once. See
+    :func:`example_config` for every available setting, or the stage
+    documentation for the full reference.
+
+    Parameters
+    ----------
+    config : dict, optional
+        A configuration dictionary to start from, for programmatic use; any
+        keyword argument overrides the matching entry.
+    **kwargs
+        Simulation settings such as ``data_path``, ``start_date``,
+        ``end_date``, ``crop``, ``irrigation``, ``output_dir``, ``correction``.
+
+    Returns
+    -------
+    tuple
+        ``(summary_file, daily_file)``, or ``(None, None)`` if the call only
+        corrected an already-saved run.
+    """
+    return delegate("simulate", "run")(config, **kwargs)
+
+
+def example_config():
+    """Return the example configuration, to inspect the available settings.
+
+    Not a required step: :func:`run` takes the same settings as keyword
+    arguments. Useful for seeing every key and its default.
+    """
+    return delegate("simulate", "example_config")()
+
+
+def input_requirements():
+    """Print the input files a simulation needs, with units and naming."""
+    return delegate("simulate", "input_requirements")()
+
+
+def build_reference(**kwargs):
+    """Build a per-year, region-level yield reference from a boundary file and
+    a statistics table."""
+    return delegate("simulate", "build_reference")(**kwargs)
+
+
+def correct(config, logger=None):
+    """Bias-correct or calibrate an already-saved run, without re-simulating."""
+    return delegate("simulate", "correct")(config, logger=logger)
+
+
+def compare(args=None):
+    """Compare corrected runs against the reference: per-year maps, region
+    difference maps, a domain time series and a statistics table."""
+    return delegate("simulate", "compare")(args)
+
+
+def load_results(path, value_col="Dry yield (tonne/ha)", start_year=None):
+    """Load a saved ``summary_results_*.pkl`` as tidy per-year points."""
+    return delegate("simulate", "load_results")(path, value_col, start_year)

geoaquacrop-0.1.0/src/geoaquacrop/visualize.py

@@ -0,0 +1,16 @@
+"""Result visualisation — :mod:`geoaquacrop.visualize`.
+
+Façade over the ``geoaquacrop_visualize`` package::
+
+    import geoaquacrop as gac
+
+    gac.visualize.run()      # starts the dashboard, then open the printed URL
+"""
+from ._util import delegate
+
+__all__ = ["run"]
+
+
+def run(*args, **kwargs):
+    """Start the interactive dashboard."""
+    return delegate("visualize", "run")(*args, **kwargs)

geoaquacrop-0.1.0/src/geoaquacrop.egg-info/PKG-INFO

@@ -0,0 +1,172 @@
+Metadata-Version: 2.4
+Name: geoaquacrop
+Version: 0.1.0
+Summary: Unified entry point to the GeoAquaCrop toolchain: preprocessing, gridded simulation, and visualisation
+Author: Josias Lang-Ritter, Chris Bowden, Seyed Hossein Hosseini, Henrikki Tenkanen, Tim Foster
+Maintainer-email: Josias Lang-Ritter <josias.lang-ritter@aalto.fi>, Chris Bowden <christopher.bowden@manchester.ac.uk>, Seyed Hossein Hosseini <seyed.h.hosseini@aalto.fi>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/aquacropos/geoaquacrop
+Project-URL: Documentation, https://geoaquacrop.readthedocs.io
+Project-URL: Preprocessing, https://github.com/aquacropos/geoaquacrop_preprocess
+Project-URL: Simulation, https://github.com/aquacropos/geoaquacrop_simulate
+Project-URL: Visualization, https://github.com/aquacropos/geoaquacrop_visualize
+Keywords: aquacrop,crop model,water productivity,gridded,agriculture
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Scientific/Engineering :: Hydrology
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: geoaquacrop_preprocess>=0.1
+Requires-Dist: geoaquacrop_simulate>=0.1
+Requires-Dist: geoaquacrop_visualize>=0.1
+Provides-Extra: docs
+Requires-Dist: sphinx>=7; extra == "docs"
+Requires-Dist: furo; extra == "docs"
+Dynamic: license-file
+
+# GeoAquaCrop
+
+> Run AquaCrop-OSPy over large regions in gridded format — from raw global datasets to interactive results.
+
+![Python](https://img.shields.io/badge/python-3.11%2B-blue) ![License](https://img.shields.io/badge/license-Apache%20License%202.0-blue)
+
+## One import, three stages
+
+```python
+import geoaquacrop as gac
+
+gac.preprocess.run(...)        # download & harmonise the input datasets
+gac.simulate.run(...)          # run AquaCrop for every grid cell
+gac.visualize.run()         # explore the results
+```
+
+That is the whole API. Each stage is a separately maintained package, but you
+never need to know their names: `geoaquacrop` presents them as one library.
+
+```
+gac.preprocess  ->  gac.simulate  ->  gac.visualize
+```
+
+| Stage | What it does | Documentation |
+| ----- | ------------ | ------------- |
+| `gac.preprocess` | Downloads and harmonises climate, soil, crop calendar and crop area data onto a common grid for a given polygon and period | [readthedocs](https://geoaquacrop-preprocessing.readthedocs.io/en/stable/) |
+| `gac.simulate` | Runs AquaCrop per grid cell in parallel; optional yield bias-correction and calibration against observations | [readthedocs](https://geoaquacrop-simulate.readthedocs.io) |
+| `gac.visualize` | Interactive Dash/Plotly dashboard for exploring simulation outputs and climate inputs | [readthedocs](https://geoaquacrop-visualize.readthedocs.io/en/latest/) |
+
+## Installation
+
+```bash
+conda create -n geoaquacrop python=3.11
+conda activate geoaquacrop
+python -m pip install --pre geoaquacrop
+```
+
+The `--pre` flag is needed while the toolchain is in beta (`0.1.0b1`); pip skips
+pre-release versions otherwise. This installs all three stages.
+
+**For past climate data** you also need a free [Copernicus CDS account](https://cds.climate.copernicus.eu/)
+and API token — see the preprocessing documentation.
+
+<details>
+<summary>Installing a single stage</summary>
+
+Each stage also works standalone, with the same function names:
+
+```bash
+python -m pip install geoaquacrop_preprocess    # data preparation only
+python -m pip install geoaquacrop_simulate      # simulation only
+python -m pip install geoaquacrop_visualize     # visualisation only
+```
+
+```python
+import geoaquacrop_simulate as simulate
+summary_file, daily_file = simulate.run(data_path='...', start_date='...',
+                                        end_date='...', crop='Wheat_winter')
+```
+
+`gac.simulate.run` and `geoaquacrop_simulate.run` are the same function, so
+code written against either keeps working.
+</details>
+
+## End-to-end example
+
+A complete run for one region, using only `gac`.
+
+```python
+import geoaquacrop as gac
+
+# 1. prepare the input data
+gac.preprocess.run(
+    domain_shape_path='high_plains.geojson',   # polygon, EPSG:4326
+    start_year=2011,
+    end_year=2013,
+    api_token='your-copernicus-api-token',
+    cell_resolution=0.05,
+    workingdirectory='/data/high_plains',
+)
+
+# 2. run the simulation
+summary_file, daily_file = gac.simulate.run(
+    data_path='/data/high_plains/processed',   # fills all four input paths
+    start_date='2011/01/01',
+    end_date='2013/12/31',
+    crop='Wheat_winter',
+    irrigation='rainfed',
+    output_dir='outputs',
+)
+
+# 3. explore the results
+gac.visualize.run()          # then open http://localhost:8050
+```
+
+## What each stage offers
+
+```python
+gac.preprocess.run(...)                 # prepare every dataset
+gac.preprocess.weather(...)             # or re-run a single step
+gac.preprocess.soil(...)
+gac.preprocess.crop_calendar(...)
+gac.preprocess.crop_area(...)
+
+gac.simulate.run(data_path=..., ...)    # simulate; returns (summary, daily)
+gac.simulate.example_config()           # inspect every available setting
+gac.simulate.input_requirements()       # print required files and units
+gac.simulate.build_reference(...)       # per-year, region-level yield reference
+gac.simulate.correct(config)            # bias-correct a saved run, no re-run
+gac.simulate.compare([...])             # comparison figures and statistics
+gac.simulate.load_results(path)         # saved results as tidy per-year points
+
+gac.visualize.run()                  # start the dashboard
+```
+
+Importing `geoaquacrop` is cheap: each stage — and its dependencies — loads only
+when you first use it. If a stage is not installed, calling it tells you exactly
+what to install.
+
+## Which stage do I need?
+
+- **Model outputs for a region, starting from nothing** — all three.
+- **Already have gridded climate, soil and crop inputs** — `gac.simulate` alone.
+- **Already have simulation outputs** — `gac.visualize` alone.
+
+## Documentation
+
+- **This toolchain** — <https://geoaquacrop.readthedocs.io>
+- **Preprocessing** — <https://geoaquacrop-preprocessing.readthedocs.io/en/stable/>
+- **Simulation** — <https://geoaquacrop-simulate.readthedocs.io>
+- **Visualisation** — <https://geoaquacrop-visualize.readthedocs.io/en/latest/>
+
+Contributors: see [the stage package standard](https://geoaquacrop.readthedocs.io/en/latest/standard.html)
+for the naming and API contract each stage follows.
+
+## Citation
+
+If you use GeoAquaCrop in published work, please cite the toolchain and the
+underlying [AquaCrop-OSPy](https://github.com/aquacropos/aquacrop) model.
+
+## License
+
+Apache-2.0 — see [LICENSE](LICENSE).

geoaquacrop-0.1.0/src/geoaquacrop.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+LICENSE
+README.md
+pyproject.toml
+src/geoaquacrop/__init__.py
+src/geoaquacrop/_util.py
+src/geoaquacrop/preprocess.py
+src/geoaquacrop/simulate.py
+src/geoaquacrop/visualize.py
+src/geoaquacrop.egg-info/PKG-INFO
+src/geoaquacrop.egg-info/SOURCES.txt
+src/geoaquacrop.egg-info/dependency_links.txt
+src/geoaquacrop.egg-info/requires.txt
+src/geoaquacrop.egg-info/top_level.txt

geoaquacrop-0.1.0/src/geoaquacrop.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

geoaquacrop-0.1.0/src/geoaquacrop.egg-info/requires.txt

@@ -0,0 +1,7 @@
+geoaquacrop_preprocess>=0.1
+geoaquacrop_simulate>=0.1
+geoaquacrop_visualize>=0.1
+
+[docs]
+sphinx>=7
+furo

geoaquacrop-0.1.0/src/geoaquacrop.egg-info/top_level.txt

@@ -0,0 +1 @@
+geoaquacrop