dafab-client 3.2.0__tar.gz → 3.2.1__tar.gz

dafab_client-3.2.1/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 [yyyy] [name of copyright owner]
+
+   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.

dafab_client-3.2.1/PKG-INFO

@@ -0,0 +1,219 @@
+Metadata-Version: 2.4
+Name: dafab_client
+Version: 3.2.1
+Summary: Python client for the DaFab catalogue of Sentinel-2 imagery and AI-derived water and agriculture products, built on Rucio.
+Author: DaFab
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://www.dafab-ai.eu
+Project-URL: Discovery site, https://dafab.cern.ch/discover/
+Project-URL: STAC catalogue, https://dafab.cern.ch/stac
+Project-URL: Repository, https://github.com/DaFab-AI-eu/dafab-client
+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 :: Only
+Classifier: Topic :: Scientific/Engineering :: GIS
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: folium<1,>=0.20.0
+Requires-Dist: jsonschema<5,>=4.26.0
+Requires-Dist: packaging<27,>=26.1
+Requires-Dist: requests<3,>=2.33.1
+Requires-Dist: typing_extensions<5,>=4.15
+Requires-Dist: urllib3<3,>=2.6.3
+Provides-Extra: notebooks
+Requires-Dist: ipykernel<7,>=6.30; extra == "notebooks"
+Requires-Dist: jupyter<2,>=1.1; extra == "notebooks"
+Dynamic: license-file
+
+# DaFab Client
+
+The Python client for the DaFab catalogue.
+
+[DaFab](https://www.dafab-ai.eu) processes Copernicus Sentinel-2 imagery into AI-generated water-analysis and field-delineation products on European HPC systems, and publishes the images and the products as STAC items in a Rucio catalogue hosted at CERN. This client reads that catalogue, searches it with typed metadata filters, follows the lineage between a product and the image it was derived from, and downloads assets. It works out of the box with a shared read profile, no configuration needed.
+
+You can also browse the same catalogue without code, on the [discovery site](https://dafab.cern.ch/discover/) or through its [STAC root](https://dafab.cern.ch/stac).
+
+## Install
+
+```bash
+pip install dafab-client
+```
+
+Python 3.10 or newer. The client talks to `dafab.cern.ch` over HTTPS and downloads assets from the project's object store. For the notebook, install the `notebooks` extra described below.
+
+## First call
+
+```python
+import dafab_client as dc
+
+dc.ping()    # the server version
+dc.whoami()  # the shared read profile, account user_dafab
+```
+
+The package ships the profile `user_dafab`, meant for reading the public catalogue, together with the TLS trust bundle it uses. Publication needs a personal account, see the last section.
+
+## What the catalogue holds
+
+Everything lives in the scope `dafab` as STAC 1.1 items, each stored as a Rucio container that carries its full JSON document.
+
+| Collection | Content | Example item |
+|---|---|---|
+| `sentinel_2_l2a` | Sentinel-2 L2A source images | `S2A_MSIL2A_20160229T032652_N0500_R018_T48QUH_20231011T191655` |
+| `water_analysis` | water maps, excess and deficit polygons, previews | the image id followed by `_water_analysis_300` |
+| `smart_agriculture` | field boundaries and previews | the image id followed by `_smart_agriculture_300` |
+
+A product carries a `derived_from` link to its source image, and the source image is attached to its products in the catalogue, so lineage can be followed both ways. Facet catalogues such as `agriculture_season`, `water_anomaly` and `water_basin` group products by season, by flood, drought or normal conditions, and by river basin. Auxiliary layers used by the processing live in their own scopes, `hand`, `worldcover` and `gfm`.
+
+```python
+dc.list_stac_scopes()                       # the scopes visible to the profile
+dc.get_catalogs_and_collections()           # collections and facet catalogues, as {"scope", "id"} rows
+dc.get_items(filters={"name": "S2A_MSIL2A_20160229T032652*"}, long=False)   # item ids of one tile and date
+```
+
+`get_items` returns every item without a filter, which is tens of thousands of ids and takes a few seconds. Narrow it with `name` patterns (`*` or `%` match any sequence) or use the searches below.
+
+## Search
+
+Searches are JSON filters made of comparison nodes, each with a `path` into the document, a `comparator`, a `value` and a `valueType`, combined by logical nodes with `and`, `or` and `not`. The server evaluates them against the declared indexes.
+
+```python
+clear_images_2016 = {
+    "type": "logical", "combinator": "and", "filters": [
+        {"type": "comparison", "comparator": "equals", "path": ["collection"], "value": "sentinel_2_l2a", "valueType": "string"},
+        {"type": "comparison", "comparator": "lessThanOrEqual", "path": ["properties", "eo:cloud_cover"], "value": 20, "valueType": "number"},
+        {"type": "comparison", "comparator": "greaterThanOrEqual", "path": ["properties", "datetime"], "value": "2016-01-01T00:00:00Z", "valueType": "date"},
+        {"type": "comparison", "comparator": "lessThan", "path": ["properties", "datetime"], "value": "2017-01-01T00:00:00Z", "valueType": "date"},
+    ],
+}
+ids = dc.get_items_by_enhanced_filter(clear_images_2016, return_mode="ids")
+items = dc.get_items_by_enhanced_filter(clear_images_2016, return_mode="metadata")   # full documents
+```
+
+A group marked `"inherited": true` is evaluated against the ancestors of each candidate, so a search can select products by properties of their source image. This finds field-delineation products whose source image had at most 20 percent cloud cover.
+
+```python
+fields_from_clear_images = {
+    "type": "logical", "combinator": "and", "filters": [
+        {"type": "comparison", "comparator": "equals", "path": ["collection"], "value": "smart_agriculture", "valueType": "string"},
+        {"type": "logical", "combinator": "and", "inherited": True, "filters": [
+            {"type": "comparison", "comparator": "equals", "path": ["collection"], "value": "sentinel_2_l2a", "valueType": "string"},
+            {"type": "comparison", "comparator": "lessThanOrEqual", "path": ["properties", "eo:cloud_cover"], "value": 20, "valueType": "number"},
+        ]},
+    ],
+}
+product_ids = dc.get_items_by_enhanced_filter(fields_from_clear_images)
+```
+
+| Comparators | Meaning |
+|---|---|
+| `equals`, `notEquals` | equality, or inequality |
+| `lessThan`, `lessThanOrEqual`, `greaterThan`, `greaterThanOrEqual` | ordered comparison of numbers, dates or strings |
+| `in` | the value is one of a list |
+| `like`, `notLike` | text pattern, `*` or `%` for any sequence and `?` for one character |
+| `contains`, `containsAny`, `containsAll` | array membership |
+| `isNull`, `isNotNull`, `isEmpty`, `isNotEmpty` | presence checks, pass `"value": null` |
+
+Value types are `string`, `number`, `integer`, `boolean`, `date` and `array`. A document that lacks the field matches neither a typed comparison nor its negation, so incomplete metadata is left out rather than silently included.
+
+Three helpers build the common spatial and temporal searches for you, and return ids or full documents with `return_mode`.
+
+```python
+dc.get_items_by_timerange("2016-02-01T00:00:00Z", "2016-03-01T00:00:00Z")
+dc.get_items_by_bbox(103.5, 19.8, 104.2, 20.8)                    # west, south, east, north
+dc.get_items_by_bbox_and_timerange([103.5, 19.8, 104.2, 20.8], ["2016-02-01T00:00:00Z", "2016-03-01T00:00:00Z"])
+```
+
+Lineage and facets have their own helpers.
+
+```python
+image = "S2A_MSIL2A_20160229T032652_N0500_R018_T48QUH_20231011T191655"
+product = image + "_smart_agriculture_300"
+
+dc.get_source_original_item_ids_from_derived_item(product)      # the image the product came from
+dc.get_related_item_ids_from_original_item(image)                # every product of the image
+dc.get_sibling_derived_item_ids(image, collection_id="smart_agriculture")
+dc.get_item_ids_by_top_facet_catalog("water_basin")              # products placed under any river basin
+dc.get_item_ids_by_facet_value_catalog("water_basin_mekong")     # products in one basin
+dc.get_item_facet_placements(product, collection_id="smart_agriculture")
+```
+
+## Read metadata
+
+```python
+document = dc.get_bulk_metadata(product)                          # the whole STAC item
+subset = dc.get_bulk_metadata(product, paths=["/collection", "/properties/datetime", "/assets"])
+dc.extract_metadata_value("/properties/datetime", pname=image)     # one value by JSON pointer
+report = dc.list_item_asset_entries(product, check_storage=True)  # every asset and whether its file is in storage
+```
+
+`dc.as_json(document)` formats any of these for display.
+
+## Download assets
+
+```python
+dc.download_item_asset(product, "dafab-field-boundaries-thumbnail", destination_dir="downloads")
+href = dc.build_stable_asset_href(image, "TCI_20m")               # the permanent URL of an asset
+dc.download_asset_from_stable_href(href, destination_dir="downloads")
+dc.download_all_derived_item_assets(product, destination_dir="downloads")
+```
+
+Downloads go to `destination_dir`, the current directory by default, and refuse to replace an existing file unless `overwrite=True`. Where a local copy of the storage is mounted, `download_item_asset` uses it and reports `mode == "local_posix"`.
+
+`dc.get_map(items, output_path="map.html")` renders the footprints of a list of documents to an interactive HTML map.
+
+## Notebook
+
+The packaged notebook walks through all of the above against the live catalogue and runs unchanged with the shared profile. Its download cells write under `demo-data/` in the current directory.
+
+```bash
+pip install "dafab-client[notebooks]"
+python -c "import dafab_client as dc; print(dc.get_example('user'))"
+jupyter notebook dafab_simple_user_workflows.ipynb
+```
+
+## Validate a document
+
+The validators check an item against the schemas shipped with the client, either a local file or the stored copy on the server, without changing anything.
+
+```python
+dc.validate_original_item(source="server", expected_item_id=image, expected_collection_id="sentinel_2_l2a")
+dc.validate_derived_item(source="local", item_path="my_product.json")
+```
+
+## Configuration
+
+Nothing is required for reading. These variables change the defaults.
+
+| Variable | Effect |
+|---|---|
+| `DAFAB_PROFILE` | the account whose profile to load, default `user_dafab` |
+| `DAFAB_PROFILE_PATH` | an explicit profile file |
+| `DAFAB_PROFILE_DIR` | the directory holding `<account>/config`, default `~/.config/dafab/credentials/profiles` or `$XDG_CONFIG_HOME/dafab/credentials/profiles` |
+| `DAFAB_DEMO_DATA_DIR` | where the notebook and `get_map` write, default `./demo-data` |
+
+Set them before importing the client. A profile is a JSON file with the connection and the credentials of one account.
+
+```json
+{
+  "rucio_host": "https://dafab.cern.ch",
+  "auth_host": "https://dafab.cern.ch",
+  "auth_type": "userpass",
+  "account": "my_account",
+  "creds": {"username": "my_account", "password": "..."},
+  "ca_cert": "$client_path/_rucio/secrets/user_dafab/rucio_ca_bundle.pem",
+  "vo": "def"
+}
+```
+
+`ca_cert` names the TLS trust bundle. `$client_path` is the installed package, `$client_account` the account name, and `$profile_path` the directory of the profile file, so a personal profile can reuse the shipped bundle as above. Keep profile files private.
+
+## Publishing
+
+Publishing images and products, attaching them to their collections and facets, and repairing collection extents are done by DaFab's processing pipelines with the publication helpers of this package, `ensure_item`, `set_metadata`, `publish_original_asset`, `publish_derived_asset` and the `sync_*_collection_extent` family. They write to the catalogue and need an account with write access. Project members find the procedures in the repository's `docs/`. To request an account, contact the project through [dafab-ai.eu](https://www.dafab-ai.eu).
+
+## Licence
+
+Apache License 2.0. The package bundles the Rucio client modules, which are also Apache 2.0.

{dafab_client-3.2.0 → dafab_client-3.2.1}/dafab_client/example_notebooks/dafab_simple_user_workflows.ipynb

@@ -82,7 +82,7 @@
     "DERIVED_ASSET_KEY = \"dafab-field-boundaries\"\n",
     "\n",
     "TOP_FACET_CATALOG_ID = \"water_basin\"\n",
-    "FACET_VALUE_CATALOG_ID = \"water_basin_ganges\"\n",
+    "FACET_VALUE_CATALOG_ID = \"water_basin_mekong\"\n",
     "\n",
     "HAND_SCOPE = \"hand\"\n",
     "HAND_ITEM_ID = \"Copernicus_DSM_COG_10_N15_00_W018_00_HAND\"\n",

dafab_client-3.2.1/dafab_client.egg-info/PKG-INFO

@@ -0,0 +1,219 @@
+Metadata-Version: 2.4
+Name: dafab_client
+Version: 3.2.1
+Summary: Python client for the DaFab catalogue of Sentinel-2 imagery and AI-derived water and agriculture products, built on Rucio.
+Author: DaFab
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://www.dafab-ai.eu
+Project-URL: Discovery site, https://dafab.cern.ch/discover/
+Project-URL: STAC catalogue, https://dafab.cern.ch/stac
+Project-URL: Repository, https://github.com/DaFab-AI-eu/dafab-client
+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 :: Only
+Classifier: Topic :: Scientific/Engineering :: GIS
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: folium<1,>=0.20.0
+Requires-Dist: jsonschema<5,>=4.26.0
+Requires-Dist: packaging<27,>=26.1
+Requires-Dist: requests<3,>=2.33.1
+Requires-Dist: typing_extensions<5,>=4.15
+Requires-Dist: urllib3<3,>=2.6.3
+Provides-Extra: notebooks
+Requires-Dist: ipykernel<7,>=6.30; extra == "notebooks"
+Requires-Dist: jupyter<2,>=1.1; extra == "notebooks"
+Dynamic: license-file
+
+# DaFab Client
+
+The Python client for the DaFab catalogue.
+
+[DaFab](https://www.dafab-ai.eu) processes Copernicus Sentinel-2 imagery into AI-generated water-analysis and field-delineation products on European HPC systems, and publishes the images and the products as STAC items in a Rucio catalogue hosted at CERN. This client reads that catalogue, searches it with typed metadata filters, follows the lineage between a product and the image it was derived from, and downloads assets. It works out of the box with a shared read profile, no configuration needed.
+
+You can also browse the same catalogue without code, on the [discovery site](https://dafab.cern.ch/discover/) or through its [STAC root](https://dafab.cern.ch/stac).
+
+## Install
+
+```bash
+pip install dafab-client
+```
+
+Python 3.10 or newer. The client talks to `dafab.cern.ch` over HTTPS and downloads assets from the project's object store. For the notebook, install the `notebooks` extra described below.
+
+## First call
+
+```python
+import dafab_client as dc
+
+dc.ping()    # the server version
+dc.whoami()  # the shared read profile, account user_dafab
+```
+
+The package ships the profile `user_dafab`, meant for reading the public catalogue, together with the TLS trust bundle it uses. Publication needs a personal account, see the last section.
+
+## What the catalogue holds
+
+Everything lives in the scope `dafab` as STAC 1.1 items, each stored as a Rucio container that carries its full JSON document.
+
+| Collection | Content | Example item |
+|---|---|---|
+| `sentinel_2_l2a` | Sentinel-2 L2A source images | `S2A_MSIL2A_20160229T032652_N0500_R018_T48QUH_20231011T191655` |
+| `water_analysis` | water maps, excess and deficit polygons, previews | the image id followed by `_water_analysis_300` |
+| `smart_agriculture` | field boundaries and previews | the image id followed by `_smart_agriculture_300` |
+
+A product carries a `derived_from` link to its source image, and the source image is attached to its products in the catalogue, so lineage can be followed both ways. Facet catalogues such as `agriculture_season`, `water_anomaly` and `water_basin` group products by season, by flood, drought or normal conditions, and by river basin. Auxiliary layers used by the processing live in their own scopes, `hand`, `worldcover` and `gfm`.
+
+```python
+dc.list_stac_scopes()                       # the scopes visible to the profile
+dc.get_catalogs_and_collections()           # collections and facet catalogues, as {"scope", "id"} rows
+dc.get_items(filters={"name": "S2A_MSIL2A_20160229T032652*"}, long=False)   # item ids of one tile and date
+```
+
+`get_items` returns every item without a filter, which is tens of thousands of ids and takes a few seconds. Narrow it with `name` patterns (`*` or `%` match any sequence) or use the searches below.
+
+## Search
+
+Searches are JSON filters made of comparison nodes, each with a `path` into the document, a `comparator`, a `value` and a `valueType`, combined by logical nodes with `and`, `or` and `not`. The server evaluates them against the declared indexes.
+
+```python
+clear_images_2016 = {
+    "type": "logical", "combinator": "and", "filters": [
+        {"type": "comparison", "comparator": "equals", "path": ["collection"], "value": "sentinel_2_l2a", "valueType": "string"},
+        {"type": "comparison", "comparator": "lessThanOrEqual", "path": ["properties", "eo:cloud_cover"], "value": 20, "valueType": "number"},
+        {"type": "comparison", "comparator": "greaterThanOrEqual", "path": ["properties", "datetime"], "value": "2016-01-01T00:00:00Z", "valueType": "date"},
+        {"type": "comparison", "comparator": "lessThan", "path": ["properties", "datetime"], "value": "2017-01-01T00:00:00Z", "valueType": "date"},
+    ],
+}
+ids = dc.get_items_by_enhanced_filter(clear_images_2016, return_mode="ids")
+items = dc.get_items_by_enhanced_filter(clear_images_2016, return_mode="metadata")   # full documents
+```
+
+A group marked `"inherited": true` is evaluated against the ancestors of each candidate, so a search can select products by properties of their source image. This finds field-delineation products whose source image had at most 20 percent cloud cover.
+
+```python
+fields_from_clear_images = {
+    "type": "logical", "combinator": "and", "filters": [
+        {"type": "comparison", "comparator": "equals", "path": ["collection"], "value": "smart_agriculture", "valueType": "string"},
+        {"type": "logical", "combinator": "and", "inherited": True, "filters": [
+            {"type": "comparison", "comparator": "equals", "path": ["collection"], "value": "sentinel_2_l2a", "valueType": "string"},
+            {"type": "comparison", "comparator": "lessThanOrEqual", "path": ["properties", "eo:cloud_cover"], "value": 20, "valueType": "number"},
+        ]},
+    ],
+}
+product_ids = dc.get_items_by_enhanced_filter(fields_from_clear_images)
+```
+
+| Comparators | Meaning |
+|---|---|
+| `equals`, `notEquals` | equality, or inequality |
+| `lessThan`, `lessThanOrEqual`, `greaterThan`, `greaterThanOrEqual` | ordered comparison of numbers, dates or strings |
+| `in` | the value is one of a list |
+| `like`, `notLike` | text pattern, `*` or `%` for any sequence and `?` for one character |
+| `contains`, `containsAny`, `containsAll` | array membership |
+| `isNull`, `isNotNull`, `isEmpty`, `isNotEmpty` | presence checks, pass `"value": null` |
+
+Value types are `string`, `number`, `integer`, `boolean`, `date` and `array`. A document that lacks the field matches neither a typed comparison nor its negation, so incomplete metadata is left out rather than silently included.
+
+Three helpers build the common spatial and temporal searches for you, and return ids or full documents with `return_mode`.
+
+```python
+dc.get_items_by_timerange("2016-02-01T00:00:00Z", "2016-03-01T00:00:00Z")
+dc.get_items_by_bbox(103.5, 19.8, 104.2, 20.8)                    # west, south, east, north
+dc.get_items_by_bbox_and_timerange([103.5, 19.8, 104.2, 20.8], ["2016-02-01T00:00:00Z", "2016-03-01T00:00:00Z"])
+```
+
+Lineage and facets have their own helpers.
+
+```python
+image = "S2A_MSIL2A_20160229T032652_N0500_R018_T48QUH_20231011T191655"
+product = image + "_smart_agriculture_300"
+
+dc.get_source_original_item_ids_from_derived_item(product)      # the image the product came from
+dc.get_related_item_ids_from_original_item(image)                # every product of the image
+dc.get_sibling_derived_item_ids(image, collection_id="smart_agriculture")
+dc.get_item_ids_by_top_facet_catalog("water_basin")              # products placed under any river basin
+dc.get_item_ids_by_facet_value_catalog("water_basin_mekong")     # products in one basin
+dc.get_item_facet_placements(product, collection_id="smart_agriculture")
+```
+
+## Read metadata
+
+```python
+document = dc.get_bulk_metadata(product)                          # the whole STAC item
+subset = dc.get_bulk_metadata(product, paths=["/collection", "/properties/datetime", "/assets"])
+dc.extract_metadata_value("/properties/datetime", pname=image)     # one value by JSON pointer
+report = dc.list_item_asset_entries(product, check_storage=True)  # every asset and whether its file is in storage
+```
+
+`dc.as_json(document)` formats any of these for display.
+
+## Download assets
+
+```python
+dc.download_item_asset(product, "dafab-field-boundaries-thumbnail", destination_dir="downloads")
+href = dc.build_stable_asset_href(image, "TCI_20m")               # the permanent URL of an asset
+dc.download_asset_from_stable_href(href, destination_dir="downloads")
+dc.download_all_derived_item_assets(product, destination_dir="downloads")
+```
+
+Downloads go to `destination_dir`, the current directory by default, and refuse to replace an existing file unless `overwrite=True`. Where a local copy of the storage is mounted, `download_item_asset` uses it and reports `mode == "local_posix"`.
+
+`dc.get_map(items, output_path="map.html")` renders the footprints of a list of documents to an interactive HTML map.
+
+## Notebook
+
+The packaged notebook walks through all of the above against the live catalogue and runs unchanged with the shared profile. Its download cells write under `demo-data/` in the current directory.
+
+```bash
+pip install "dafab-client[notebooks]"
+python -c "import dafab_client as dc; print(dc.get_example('user'))"
+jupyter notebook dafab_simple_user_workflows.ipynb
+```
+
+## Validate a document
+
+The validators check an item against the schemas shipped with the client, either a local file or the stored copy on the server, without changing anything.
+
+```python
+dc.validate_original_item(source="server", expected_item_id=image, expected_collection_id="sentinel_2_l2a")
+dc.validate_derived_item(source="local", item_path="my_product.json")
+```
+
+## Configuration
+
+Nothing is required for reading. These variables change the defaults.
+
+| Variable | Effect |
+|---|---|
+| `DAFAB_PROFILE` | the account whose profile to load, default `user_dafab` |
+| `DAFAB_PROFILE_PATH` | an explicit profile file |
+| `DAFAB_PROFILE_DIR` | the directory holding `<account>/config`, default `~/.config/dafab/credentials/profiles` or `$XDG_CONFIG_HOME/dafab/credentials/profiles` |
+| `DAFAB_DEMO_DATA_DIR` | where the notebook and `get_map` write, default `./demo-data` |
+
+Set them before importing the client. A profile is a JSON file with the connection and the credentials of one account.
+
+```json
+{
+  "rucio_host": "https://dafab.cern.ch",
+  "auth_host": "https://dafab.cern.ch",
+  "auth_type": "userpass",
+  "account": "my_account",
+  "creds": {"username": "my_account", "password": "..."},
+  "ca_cert": "$client_path/_rucio/secrets/user_dafab/rucio_ca_bundle.pem",
+  "vo": "def"
+}
+```
+
+`ca_cert` names the TLS trust bundle. `$client_path` is the installed package, `$client_account` the account name, and `$profile_path` the directory of the profile file, so a personal profile can reuse the shipped bundle as above. Keep profile files private.
+
+## Publishing
+
+Publishing images and products, attaching them to their collections and facets, and repairing collection extents are done by DaFab's processing pipelines with the publication helpers of this package, `ensure_item`, `set_metadata`, `publish_original_asset`, `publish_derived_asset` and the `sync_*_collection_extent` family. They write to the catalogue and need an account with write access. Project members find the procedures in the repository's `docs/`. To request an account, contact the project through [dafab-ai.eu](https://www.dafab-ai.eu).
+
+## Licence
+
+Apache License 2.0. The package bundles the Rucio client modules, which are also Apache 2.0.

{dafab_client-3.2.0 → dafab_client-3.2.1}/dafab_client.egg-info/SOURCES.txt

@@ -1,3 +1,4 @@
+LICENSE
 MANIFEST.in
 pyproject.toml
 readme.md