geoaquacrop-simulate 0.1.0__tar.gz

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

@@ -0,0 +1,165 @@
+Metadata-Version: 2.4
+Name: geoaquacrop_simulate
+Version: 0.1.0
+Summary: Gridded AquaCrop-OSPy simulation runner
+Author: Josias Lang-Ritter, Christopher Bowden, Seyed Hossein Hosseini, Henrikki Tenkanen, Timothy Foster
+Maintainer-email: Christopher Bowden <christopher.bowden@manchester.ac.uk>
+License-Expression: Apache-2.0
+Project-URL: Documentation, https://geoaquacrop-simulate.readthedocs.io/en/stable/
+Project-URL: Homepage, https://github.com/aquacropos/geoaquacrop_simulate
+Project-URL: Preprocessing, https://github.com/aquacropos/geoaquacrop_preprocess
+Project-URL: Visualization, https://github.com/aquacropos/geoaquacrop_visualize
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+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: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
+Classifier: Topic :: Scientific/Engineering :: Hydrology
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: pandas
+Requires-Dist: xarray>=2025.1
+Requires-Dist: netcdf4
+Requires-Dist: tqdm
+Requires-Dist: aquacrop>=3.1.0
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Provides-Extra: correction
+Requires-Dist: geopandas; extra == "correction"
+Requires-Dist: matplotlib; extra == "correction"
+Provides-Extra: docs
+Requires-Dist: sphinx>=7; extra == "docs"
+Requires-Dist: furo; extra == "docs"
+Dynamic: license-file
+
+# geoaquacrop_simulate
+
+> Gridded AquaCrop-OSPy simulation engine for the GeoAquaCrop toolchain.
+
+![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_simulate** runs [AquaCrop-OSPy](https://github.com/aquacropos/aquacrop) over large regions in gridded format. It takes the harmonised input datasets produced by [geoaquacrop_preprocess](https://github.com/aquacropos/geoaquacrop_preprocess), runs an independent AquaCrop simulation for every grid cell in parallel, and writes per-cell seasonal and daily results. These outputs can then be visualized by [geoaquacrop_visualize](https://github.com/aquacropos/geoaquacrop_visualize).
+
+It is the middle stage of the GeoAquaCrop toolchain:
+
+```
+geoaquacrop_preprocess  ->  geoaquacrop_simulate  ->  geoaquacrop_visualize
+(download & harmonise)   (simulate & correct)         (explore results)
+```
+
+| Stage | Description |
+| ----- | ----------- |
+| Input validation | Checks that climate, soil, crop calendar and crop area files exist, share a grid, and cover the requested period; derives the simulated cells from the crop area mask |
+| Per-cell simulation | Builds an AquaCrop `Soil`, `Crop` and weather series per cell, adjusts crop phenology to the local growing season, runs to termination |
+| Parallel execution | Distributes cells over worker processes with a progress bar; per-cell failures are logged without stopping the run |
+| Derived outputs | Adds seasonal water-balance metrics via a pluggable enricher registry |
+| Yield correction | Optionally bias-corrects or calibrates yields against an observational reference, per year, at the reference's native support |
+
+## 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/)
+- Python 3.11+
+- Input datasets produced by [geoaquacrop_preprocess](https://github.com/aquacropos/geoaquacrop_preprocess)
+
+## Installation
+
+```bash
+git clone https://github.com/aquacropos/geoaquacrop_simulate
+cd geoaquacrop_simulate
+conda create -n geoaquacrop python=3.11
+conda activate geoaquacrop
+python -m pip install -e .
+```
+
+Optional extras: `.[dev]` (pytest), `.[correction]` (geopandas, matplotlib), `.[plots]` (dash, plotly).
+
+## Quick start
+
+### Option A — edit and run the main script
+
+Open `src/geoaquacrop_simulate/run_aquacrop.py`, set the configuration dictionary at the top of `main()`, and run:
+
+```bash
+conda activate geoaquacrop
+python -m geoaquacrop_simulate.run_aquacrop
+```
+
+Key input arguments:
+
+```python
+config_dict = {
+    'weather_path': '/path/to/geoaquacrop_preprocess/processed',
+    'soil_path':    '/path/to/geoaquacrop_preprocess/processed',
+    'pheno_path':   '/path/to/geoaquacrop_preprocess/processed',
+    'spam_path':    '/path/to/geoaquacrop_preprocess/processed',
+    'start_date':   '2008/01/01',
+    'end_date':     '2010/12/31',
+    'crop':         'Maize',
+    'irrigation':   'rainfed',      # 'rainfed' | 'irrigated'
+    'output_dir':   'outputs',
+}
+```
+
+### Option B — Python API
+
+```python
+from geoaquacrop_simulate.run_aquacrop import main
+
+summary_file, daily_file = main()
+```
+
+This is also how to run from an IDE console (Spyder, Jupyter). Do not execute module files directly — a module run as a script has no package context and its relative imports fail.
+
+## Output files
+
+Written to `<output_dir>/`:
+
+| File | Contents |
+| ---- | -------- |
+| `summary_results_<timestamp>.pkl` | One seasonal summary row per cell per season: yields, irrigation, harvest date, plus derived metrics |
+| `daily_results_<timestamp>.pkl` | Daily water-balance and crop-growth series per cell |
+| `logs/aquacrop_simulation_<timestamp>.log` | Run log, including per-cell failures |
+| `yield_scaled.nc` / `yield_calibrated.nc` | Corrected yield grids, if a correction was configured |
+
+## Yield correction
+
+Optional. Brings modelled yields into line with an observational reference, per year, aggregating the model up to the reference's native support (e.g. counties) rather than rasterising the observations.
+
+```python
+'correction': {
+    'method': 'scale',            # None | 'scale' | 'calibrate'
+    'reference_path': 'reference/high_plains_maize_reference.geojson',
+    'scale_mode': 'local',        # 'global' | 'local'
+    'lever': 'canopy',            # calibrate: 'canopy' (CCx) | 'biomass' (WP)
+    'reuse_results': 'latest',    # scale an existing run with no simulation
+}
+```
+
+See the [yield correction guide](https://geoaquacrop-simulate.readthedocs.io/en/stable/corrections.html) for what each mode does and how to interpret the results.
+
+## Documentation
+
+Full documentation: <https://geoaquacrop-simulate.readthedocs.io>
+
+## Tests
+
+```bash
+python -m pytest -q
+```
+
+## License
+
+Apache 2.0 — see [LICENSE](LICENSE).

geoaquacrop_simulate-0.1.0/README.md

@@ -0,0 +1,124 @@
+# geoaquacrop_simulate
+
+> Gridded AquaCrop-OSPy simulation engine for the GeoAquaCrop toolchain.
+
+![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_simulate** runs [AquaCrop-OSPy](https://github.com/aquacropos/aquacrop) over large regions in gridded format. It takes the harmonised input datasets produced by [geoaquacrop_preprocess](https://github.com/aquacropos/geoaquacrop_preprocess), runs an independent AquaCrop simulation for every grid cell in parallel, and writes per-cell seasonal and daily results. These outputs can then be visualized by [geoaquacrop_visualize](https://github.com/aquacropos/geoaquacrop_visualize).
+
+It is the middle stage of the GeoAquaCrop toolchain:
+
+```
+geoaquacrop_preprocess  ->  geoaquacrop_simulate  ->  geoaquacrop_visualize
+(download & harmonise)   (simulate & correct)         (explore results)
+```
+
+| Stage | Description |
+| ----- | ----------- |
+| Input validation | Checks that climate, soil, crop calendar and crop area files exist, share a grid, and cover the requested period; derives the simulated cells from the crop area mask |
+| Per-cell simulation | Builds an AquaCrop `Soil`, `Crop` and weather series per cell, adjusts crop phenology to the local growing season, runs to termination |
+| Parallel execution | Distributes cells over worker processes with a progress bar; per-cell failures are logged without stopping the run |
+| Derived outputs | Adds seasonal water-balance metrics via a pluggable enricher registry |
+| Yield correction | Optionally bias-corrects or calibrates yields against an observational reference, per year, at the reference's native support |
+
+## 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/)
+- Python 3.11+
+- Input datasets produced by [geoaquacrop_preprocess](https://github.com/aquacropos/geoaquacrop_preprocess)
+
+## Installation
+
+```bash
+git clone https://github.com/aquacropos/geoaquacrop_simulate
+cd geoaquacrop_simulate
+conda create -n geoaquacrop python=3.11
+conda activate geoaquacrop
+python -m pip install -e .
+```
+
+Optional extras: `.[dev]` (pytest), `.[correction]` (geopandas, matplotlib), `.[plots]` (dash, plotly).
+
+## Quick start
+
+### Option A — edit and run the main script
+
+Open `src/geoaquacrop_simulate/run_aquacrop.py`, set the configuration dictionary at the top of `main()`, and run:
+
+```bash
+conda activate geoaquacrop
+python -m geoaquacrop_simulate.run_aquacrop
+```
+
+Key input arguments:
+
+```python
+config_dict = {
+    'weather_path': '/path/to/geoaquacrop_preprocess/processed',
+    'soil_path':    '/path/to/geoaquacrop_preprocess/processed',
+    'pheno_path':   '/path/to/geoaquacrop_preprocess/processed',
+    'spam_path':    '/path/to/geoaquacrop_preprocess/processed',
+    'start_date':   '2008/01/01',
+    'end_date':     '2010/12/31',
+    'crop':         'Maize',
+    'irrigation':   'rainfed',      # 'rainfed' | 'irrigated'
+    'output_dir':   'outputs',
+}
+```
+
+### Option B — Python API
+
+```python
+from geoaquacrop_simulate.run_aquacrop import main
+
+summary_file, daily_file = main()
+```
+
+This is also how to run from an IDE console (Spyder, Jupyter). Do not execute module files directly — a module run as a script has no package context and its relative imports fail.
+
+## Output files
+
+Written to `<output_dir>/`:
+
+| File | Contents |
+| ---- | -------- |
+| `summary_results_<timestamp>.pkl` | One seasonal summary row per cell per season: yields, irrigation, harvest date, plus derived metrics |
+| `daily_results_<timestamp>.pkl` | Daily water-balance and crop-growth series per cell |
+| `logs/aquacrop_simulation_<timestamp>.log` | Run log, including per-cell failures |
+| `yield_scaled.nc` / `yield_calibrated.nc` | Corrected yield grids, if a correction was configured |
+
+## Yield correction
+
+Optional. Brings modelled yields into line with an observational reference, per year, aggregating the model up to the reference's native support (e.g. counties) rather than rasterising the observations.
+
+```python
+'correction': {
+    'method': 'scale',            # None | 'scale' | 'calibrate'
+    'reference_path': 'reference/high_plains_maize_reference.geojson',
+    'scale_mode': 'local',        # 'global' | 'local'
+    'lever': 'canopy',            # calibrate: 'canopy' (CCx) | 'biomass' (WP)
+    'reuse_results': 'latest',    # scale an existing run with no simulation
+}
+```
+
+See the [yield correction guide](https://geoaquacrop-simulate.readthedocs.io/en/stable/corrections.html) for what each mode does and how to interpret the results.
+
+## Documentation
+
+Full documentation: <https://geoaquacrop-simulate.readthedocs.io>
+
+## Tests
+
+```bash
+python -m pytest -q
+```
+
+## License
+
+Apache 2.0 — see [LICENSE](LICENSE).

geoaquacrop_simulate-0.1.0/pyproject.toml

@@ -0,0 +1,64 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "geoaquacrop_simulate"
+version = "0.1.0"             
+description = "Gridded AquaCrop-OSPy simulation runner"
+readme = "README.md"
+requires-python = ">=3.11"
+license = "Apache-2.0"
+license-files = ["LICENSE"]     
+authors = [
+    { name = "Josias Lang-Ritter" },
+    { name = "Christopher Bowden" },
+    { name = "Seyed Hossein Hosseini" },
+    { name = "Henrikki Tenkanen" },
+    { name = "Timothy Foster" },
+    ]
+
+maintainers = [
+    { name = "Christopher Bowden", email = "christopher.bowden@manchester.ac.uk" },
+]
+
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Science/Research",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Scientific/Engineering",
+    "Topic :: Scientific/Engineering :: Atmospheric Science",
+    "Topic :: Scientific/Engineering :: Hydrology",
+]
+
+dependencies = [
+    "numpy",
+    "pandas",
+    "xarray>=2025.1",
+    "netcdf4",
+    "tqdm",
+    "aquacrop>=3.1.0", # guarantee CO2 scenario-specific files                  
+]
+
+[project.optional-dependencies]
+dev = ["pytest", "pytest-cov"]
+correction = ["geopandas", "matplotlib"]   # yield correction + comparison figures
+docs = ["sphinx>=7", "furo"]
+
+
+[project.urls]
+Documentation = "https://geoaquacrop-simulate.readthedocs.io/en/stable/"
+Homepage = "https://github.com/aquacropos/geoaquacrop_simulate"
+Preprocessing = "https://github.com/aquacropos/geoaquacrop_preprocess"
+Visualization = "https://github.com/aquacropos/geoaquacrop_visualize"
+
+
+[project.scripts]
+geoaquacrop_simulate = "geoaquacrop_simulate.run_aquacrop:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]

geoaquacrop_simulate-0.1.0/setup.cfg

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

geoaquacrop_simulate-0.1.0/src/geoaquacrop_simulate/__init__.py

@@ -0,0 +1,90 @@
+"""Gridded FAO AquaCrop simulation.
+
+The simulation stage of the GeoAquaCrop toolchain. Usable on its own::
+
+    import geoaquacrop_simulate as simulate
+
+    summary_file, daily_file = simulate.run(
+        data_path='/data/region/processed',
+        start_date='2011/01/01', end_date='2013/12/31',
+        crop='Wheat_winter', irrigation='rainfed')
+
+or through the unified toolchain façade, which re-exports exactly these
+names::
+
+    import geoaquacrop as gac
+
+    gac.simulate.run(config)
+
+Everything a user needs is exported here; the module layout underneath is an
+implementation detail.
+"""
+from importlib import import_module as _import_module
+
+__all__ = [
+    "run",
+    "example_config",
+    "input_requirements",
+    "build_reference",
+    "correct",
+    "compare",
+    "load_results",
+]
+
+try:                                    # single source of truth: the metadata
+    from importlib.metadata import version as _version
+    __version__ = _version("geoaquacrop_simulate")
+except Exception:                       # not installed (e.g. running from source)
+    __version__ = "0.0.0.dev0"
+
+# Submodules are imported on first use so that `import geoaquacrop_simulate`
+# stays cheap and the optional correction dependencies (geopandas, matplotlib)
+# are only needed by the calls that actually use them.
+_LOOKUP = {
+    "run": ("run_aquacrop", "run"),
+    "input_requirements": ("run_aquacrop", "print_input_requirements"),
+    "build_reference": ("build_reference", "build"),
+    "compare": ("compare_corrections", "main"),
+}
+
+
+def __getattr__(name):
+    if name in _LOOKUP:
+        module_name, attr = _LOOKUP[name]
+        value = getattr(_import_module(f"{__name__}.{module_name}"), attr)
+        globals()[name] = value
+        return value
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
+
+
+def __dir__():
+    return sorted(set(list(globals()) + __all__))
+
+
+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.
+    """
+    import copy
+    return copy.deepcopy(_import_module(f"{__name__}.run_aquacrop").EXAMPLE_CONFIG)
+
+
+def correct(config, logger=None):
+    """Bias-correct or calibrate an already-saved run, without re-simulating.
+
+    Requires ``config['correction']['reuse_results']`` to be set.
+    """
+    correction = _import_module(f"{__name__}.correction")
+    return correction.correct_saved_run(config, logger=logger)
+
+
+def load_results(path, value_col="Dry yield (tonne/ha)", start_year=None):
+    """Load a saved ``summary_results_*.pkl`` as tidy per-year points
+    ``[year, y, x, val]``."""
+    import pickle
+    correction = _import_module(f"{__name__}.correction")
+    with open(path, "rb") as fh:
+        summary_results = pickle.load(fh)
+    return correction.summary_to_points(summary_results, value_col, start_year)