queryearth 0.0.1__tar.gz

queryearth-0.0.1/.gitignore

@@ -0,0 +1,8 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+build/
+dist/
+.pytest_cache/
+.ipynb_checkpoints/
+queryearth/_version.py

queryearth-0.0.1/LICENSE

@@ -0,0 +1,201 @@
+                                 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 2020-2025 University Corporation for Atmospheric Research (UCAR)
+  
+   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.

queryearth-0.0.1/MANIFEST.in

@@ -0,0 +1,3 @@
+prune docs
+prune .github
+exclude CLAUDE.md

queryearth-0.0.1/PKG-INFO

@@ -0,0 +1,55 @@
+Metadata-Version: 2.4
+Name: queryearth
+Version: 0.0.1
+Summary: Match rules scoped by area, time and other dimensions to a request, and get caveats, coverage gaps and recommendations.
+Author: Manish Venumuddula
+License-Expression: Apache-2.0
+Project-URL: Repository, https://github.com/CROCODILE-CESM/queryearth
+Keywords: geospatial,advisories,data quality,rules,earth science
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: GIS
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: shapely>=2.1
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: jsonschema; extra == "test"
+Requires-Dist: cftime; extra == "test"
+Requires-Dist: pandas; extra == "test"
+Requires-Dist: pyproj; extra == "test"
+Dynamic: license-file
+
+# queryearth
+
+queryearth answers one question: given where (a point or a polygon, such as a lake outline or a model domain), when (a time range) and anything else that matters (grid resolution, product, variable and so on), which registered rules apply, how much of the request does each one cover, and what does it say to watch out for or to do?
+
+Rules are GeoJSON features or short Python classes. A query returns findings of three kinds: caveats ("these values are climatology, not observations"), coverage gaps ("this product does not reach part of your request") and recommendations ("set this model parameter"). queryearth ships no rules of its own; you bring yours.
+
+**Status:** pre-alpha. The design is in [docs/design.md](docs/design.md). To try it, run [examples/toy/play.py](examples/toy/play.py), which loads a small made-up pack and walks through queries, coverage gaps, Python rules, `emit()`, `suitable()` and `query_points()`.
+
+## Install
+
+```bash
+pip install queryearth
+```
+
+queryearth needs Python 3.11 or later, numpy and shapely 2.1 or later.
+
+## Development
+
+```bash
+pip install -e ".[test]"
+pytest
+black .
+```
+
+Versions come from git tags through setuptools-scm. Every push to `main` builds the package, and every GitHub release tagged `vX.Y.Z` publishes version X.Y.Z to PyPI.
+
+## Licence
+
+Apache-2.0.

queryearth-0.0.1/README.md

@@ -0,0 +1,29 @@
+# queryearth
+
+queryearth answers one question: given where (a point or a polygon, such as a lake outline or a model domain), when (a time range) and anything else that matters (grid resolution, product, variable and so on), which registered rules apply, how much of the request does each one cover, and what does it say to watch out for or to do?
+
+Rules are GeoJSON features or short Python classes. A query returns findings of three kinds: caveats ("these values are climatology, not observations"), coverage gaps ("this product does not reach part of your request") and recommendations ("set this model parameter"). queryearth ships no rules of its own; you bring yours.
+
+**Status:** pre-alpha. The design is in [docs/design.md](docs/design.md). To try it, run [examples/toy/play.py](examples/toy/play.py), which loads a small made-up pack and walks through queries, coverage gaps, Python rules, `emit()`, `suitable()` and `query_points()`.
+
+## Install
+
+```bash
+pip install queryearth
+```
+
+queryearth needs Python 3.11 or later, numpy and shapely 2.1 or later.
+
+## Development
+
+```bash
+pip install -e ".[test]"
+pytest
+black .
+```
+
+Versions come from git tags through setuptools-scm. Every push to `main` builds the package, and every GitHub release tagged `vX.Y.Z` publishes version X.Y.Z to PyPI.
+
+## Licence
+
+Apache-2.0.

queryearth-0.0.1/examples/toy/pack.toml

@@ -0,0 +1,37 @@
+# A made-up pack to play with. The products, rules and parameter names are
+# invented; nothing here describes real data or real model guidance.
+[pack]
+name = "toy"
+version = "0.1.0"
+code_prefix = ["TOY"]
+license = "CC0-1.0"
+files = ["rules.geojson"]
+
+# The dimensions the records use. They must exist on the Index the pack is
+# loaded into (play.py declares the resolution axis; the facets are defaults).
+[axes.resolution]
+unit = "km"
+description = "horizontal grid spacing"
+
+[facets]
+names = ["product", "variable", "model"]
+
+# A global ocean reanalysis, from 1993 onwards.
+[products.toy_ocean]
+aliases = ["TOYO"]
+variables = ["thetao", "so", "zos"]
+resolution = [0.25, "deg"]
+coverage = { time = ["1993-01-01", ".."] }
+
+# A global atmosphere reanalysis, from 1950 onwards.
+[products.toy_atmos]
+variables = ["t2m", "tp"]
+resolution = [0.5, "deg"]
+coverage = { time = ["1950-01-01", ".."] }
+
+# A regional ocean product that covers one box (roughly the Gulf of Mexico)
+# for 2010 to 2023 only.
+[products.toy_coastal]
+variables = ["thetao", "so"]
+resolution = [2.0, "km"]
+coverage = { time = ["2010-01-01", "2023-12-31"], box = { west = -98, width = 18, south = 18, north = 31 } }

queryearth-0.0.1/examples/toy/play.py

@@ -0,0 +1,181 @@
+"""Play with queryearth on a made-up pack.
+
+Run it cell by cell in VS Code (each "# %%" line starts a cell), or as a script
+from the repository root:
+
+    pip install -e .
+    python examples/toy/play.py
+
+Everything in the toy pack is invented: the products (toy_ocean, toy_atmos,
+toy_coastal), the rules (TOY...) and the parameter names. Edit pack.toml,
+rules.geojson or this file and rerun to see what changes.
+"""
+
+# %% Set up: an Index with a resolution axis, then load the toy pack.
+import logging
+from pathlib import Path
+
+import numpy as np
+
+import queryearth as qe
+from queryearth import space as sp
+
+HERE = Path(globals().get("__file__", "play.py")).resolve().parent
+
+index = qe.Index("toy", axes=[qe.Axis("resolution", "km")])
+print("loaded:", index.load_pack(HERE))
+print("products:", list(index.products))
+
+
+def show(findings):
+    """One line per finding, then any suggestions under it."""
+    if not findings:
+        print("  (no findings)")
+    for f in findings:
+        area, time = (
+            "-" if x is None else f"{x:.0%}" for x in (f.area_fraction, f.time_fraction)
+        )
+        print(f"  {f.code:7} {f.kind:14} {f.severity.name:8} {f.product or '-':11}")
+        print(f"          {f.title}")
+        print(f"          area {area}, time {time}, periods {f.time_overlap}")
+        if f.conditional_on:
+            print(f"          conditional on {f.conditional_on}")
+        if f.assumed:
+            print(f"          filled from the product: {f.assumed}")
+        for s in f.suggestions:
+            print(f"          -> set {s.target}:{s.key} = {s.value!r}")
+
+
+# %% 1. A Bering Sea domain that crosses the antimeridian, winter 2000-01, 8 km.
+# TOY002 covers only December to March, so its time fraction is below 1.
+# TOY101 needs the Arctic, and only the top of this domain is north of 66.5N.
+bering = sp.box(165, 52, -160, 70)  # west, south, east, north
+winter = qe.interval("2000-11-01", "2001-03-31")
+show(
+    index.query(
+        space=bering,
+        time=winter,
+        axes={"resolution": (8, 8)},
+        facets={"model": ["mom6"]},
+        requests=[qe.Request("toy_ocean", variables=("thetao", "so"))],
+    )
+)
+
+# %% 2. The same domain with no time: each product's coverage is used instead,
+# and the findings say so in "filled from the product".
+show(
+    index.query(
+        space=bering,
+        axes={"resolution": (8, 8)},
+        requests=[qe.Request("toy_ocean", variables="so")],
+    )
+)
+
+# %% 3. Resolution only. TOY102 applies outright; with include_conditional=True
+# the other rules come back too, each naming what the query left out.
+show(index.query(axes={"resolution": (3, 3)}, include_conditional=True))
+
+# %% 4. Coverage gaps. toy_coastal covers one box from 2010 to 2023 only, so
+# asking for it in the Bering Sea gives QE001 (space) and in 2005 QE002 (time).
+show(index.query(space=bering, time=winter, requests=["toy_coastal"]))
+gulf = sp.box(-95, 22, -85, 29)
+show(
+    index.query(
+        space=gulf,
+        time=qe.interval("2005-01-01", "2005-12-31"),
+        requests=["toy_coastal"],
+    )
+)
+
+# %% 5. Rules written in Python. A static rule, and a computed rule whose
+# suggestion depends on the query (a made-up time step from the finest cells).
+index.add(
+    qe.Rule(
+        code="TOY201",
+        kind="caveat",
+        title="toy_atmos 2 m temperature is too cold over sea ice",
+        message="Over sea ice, toy_atmos t2m runs a few kelvin too cold.",
+        severity=qe.Severity.WARNING,
+        scope=qe.Scope(
+            space=sp.box(-180, 60, 180, 90), facets={"product": ["toy_atmos"]}
+        ),
+    )
+)
+
+
+@index.rule(
+    "TOY202",
+    kind="recommendation",
+    axes={"resolution": {"gt": 0}},  # needs a resolution, so conditional without one
+)
+def time_step(query, match):
+    """Set the toy time step from the finest cells"""
+    finest_km = match.axes["resolution"].lo
+    seconds = 30.0 * finest_km  # made up: 30 s per km
+    return {"suggestions": [qe.Suggestion("MOM_input", "TOY_DT", seconds, "made up")]}
+
+
+show(
+    index.query(
+        space=bering,
+        time=winter,
+        axes={"resolution": (4, 12)},
+        requests=["toy_atmos"],
+    )
+)
+
+# %% 6. Findings are data; emit() reports them. Try each mode.
+findings = index.query(
+    space=bering,
+    time=winter,
+    axes={"resolution": (8, 8)},
+    facets={"model": ["mom6"]},
+    requests=[qe.Request("toy_ocean", variables=("thetao", "so"))],
+)
+
+qe.emit(findings)  # default: Python warnings for caveats, log lines for advice
+
+logging.basicConfig(level=logging.INFO, format="%(levelname)s %(message)s", force=True)
+qe.emit(findings, mode="log")
+
+collected = []
+qe.emit(findings, mode=lambda finding, text: collected.append(text))  # a sink
+print("sink got:", collected)
+
+try:
+    qe.emit(findings, mode="raise")
+except qe.AdvisoryError as err:
+    print("raised for:", [f.code for f in err.findings])
+
+with qe.policy(mode="log", ignore={"TOY002"}, show_recommendations=False):
+    qe.emit(findings)  # only TOY001 is left
+
+# %% 7. Which product suits salinity in the Gulf in 2000? toy_coastal starts in
+# 2010 so it drops out; toy_ocean stays, with TOY001 against it. A low score
+# means fewer known concerns, not better data.
+for s in index.suitable(
+    qe.Query(space=gulf, time=qe.interval("2000-01-01", "2000-12-31")),
+    "so",
+    include_dropped=True,
+):
+    print(f"  {s.product.name:11} score {s.score}  {[f.code for f in s.findings]}")
+
+# %% 8. Many points at once: every 1-degree cell centre, January 2001, toy_ocean.
+lon, lat = np.meshgrid(np.arange(-179.5, 180, 1.0), np.arange(-89.5, 90, 1.0))
+result = index.query_points(
+    lon,
+    lat,
+    time=qe.interval("2001-01-01", "2001-01-31"),
+    requests=[qe.Request("toy_ocean", variables="thetao")],
+)
+for key, mask in result.masks.items():
+    print(f"  {key}: {mask.sum()} of {mask.size} points")
+
+try:
+    import matplotlib.pyplot as plt
+
+    plt.pcolormesh(lon, lat, result.any(min_severity="info"), shading="nearest")
+    plt.title("points with a finding")
+    plt.show()
+except ImportError:
+    pass