defair 0.4.0rc2__tar.gz

defair-0.4.0rc2/LICENSE

@@ -0,0 +1,175 @@
+
+                                 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.

defair-0.4.0rc2/PKG-INFO

@@ -0,0 +1,295 @@
+Metadata-Version: 2.4
+Name: defair
+Version: 0.4.0rc2
+Summary: Destination Earth Framework for preparing AI-Ready data
+Keywords: eumetsat,defair,destine,destination earth,machine learning,earth observation
+Author: Dusan Figala, Erwan Fassot
+Author-email: Dusan Figala <dusan@oxidian.com>, Erwan Fassot <erwan@oxidian.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: GIS
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: defair-ops
+Requires-Dist: defair-data
+Requires-Dist: typer>=0.19.2
+Requires-Dist: loguru>=0.7.3
+Requires-Dist: h5netcdf>=1.6.4
+Requires-Dist: pydantic>=2.12.3
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: psutil>=7.1.1
+Requires-Dist: bokeh>=3.8.2
+Requires-Dist: urllib3>=2.6.3
+Requires-Dist: aiohttp>=3.13.3
+Requires-Dist: dask-gateway>=2023.1.1
+Requires-Dist: satpy>=0.60 ; python_full_version >= '3.11' and extra == 'benchmark'
+Requires-Dist: pyresample>=1.28 ; extra == 'benchmark'
+Requires-Dist: matplotlib>=3.10,<3.11 ; extra == 'benchmark'
+Requires-Dist: python-geotiepoints>=1.7.5 ; extra == 'benchmark'
+Requires-Dist: cartopy>=0.25.0 ; extra == 'visualization'
+Requires-Python: >=3.10
+Provides-Extra: benchmark
+Provides-Extra: visualization
+Description-Content-Type: text/markdown
+
+# DEFAIR
+
+DEFAIR (Destination Earth Framework for preparing AI-Ready data) reads,
+transforms, aligns, and writes meteorological and Earth-observation data as
+Dask-backed xarray datasets. Its plugin system supports EUMETSAT product
+readers, local and S3-compatible storage, geospatial transformations, and
+NetCDF/Zarr output.
+
+## Installation
+
+DEFAIR requires Python 3.10 or later. Install a supplied wheel bundle into a
+virtual environment:
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+python -m pip install /path/to/dist/*.whl
+```
+
+For development from a source checkout, install the uv-managed workspace:
+
+```bash
+make install
+```
+
+DEFAIR releases frequently. Pin the exact version in reproducible pipelines
+and check the release notes, which list the resolved ticket numbers, before
+upgrading.
+
+## First dataset
+
+`Dataset.from_source()` accepts a local path, an S3 URI, a glob, or an explicit
+list of paths. The reader and source plugins are auto-detected when possible.
+
+```python
+from defair_data import Dataset
+
+dataset = Dataset.from_source(
+    "/data/MSG3-SEVI-MSG15-product.nat",
+    reader="msg15nat",
+    channels=["IR_108"],
+    calibration="brightness_temperature",
+    use_channel_names=True,
+)
+
+print(dataset.data)
+dataset.to_file("output/msg.zarr", writer="zarrv2")
+```
+
+Reader results are Dask-backed by default. Do not pass the removed `use_dask`
+argument.
+
+## S3 source selection
+
+For an `s3://` URI, omitting `source` auto-selects `source="s3"`. This is the
+s3fs/fsspec-backed plugin and is the normal choice for xarray and Dask
+workflows. `source="s3boto"` selects the direct boto3 plugin for source-level
+operations such as range-based file access, listing, and globbing.
+
+```python
+dataset = Dataset.from_source(
+    "s3://bucket/path/product.nc",
+    source="s3",  # optional: this is the auto-detected S3 default
+    source_kwargs={
+        "endpoint_url": "https://s3.example.com",
+        "aws_access_key_id": "...",
+        "aws_secret_access_key": "...",
+    },
+    reader="mtg_fci_l1c_nc",
+)
+```
+
+Both plugins pass the same read settings to xarray. `s3boto` changes how DEFAIR
+lists files and performs direct reads, but xarray readers may still use s3fs.
+See [Data loading, S3, and streaming](docs/data-loading.md) for the differences,
+credential options, and performance settings.
+
+## Large multi-file datasets
+
+Normal multi-file loading builds one `Dataset`, while reading array data only
+when it is needed. For a large collection of files, use `streaming=True`.
+DEFAIR processes a fixed number of scene groups at a time and appends each
+group to Zarr:
+
+```python
+cube = Dataset.from_source(
+    "s3://bucket/archive/*.nc",
+    reader="mtg_fci_l1c_nc",
+    use_channel_names=True,
+    streaming=True,
+    stream_batch_size=4,
+)
+
+cube = cube.transform("content_filter", include_vars=["vis_06", "ir_105"])
+cube.to_file("output/archive.zarr", writer="zarrv2")
+```
+
+A streaming plan does not provide `.data`. It records supported transformations
+and writes only to Zarr. Reload the Zarr to inspect the result. Use
+`streaming=False` when you need the complete dataset or an operation that
+combines all files.
+
+## Discovering capabilities and reader options
+
+List registered plugins and inspect the selected reader's constructor and
+`read()` signatures. Options from both signatures can be passed through
+`Dataset.from_source()`. IDE completion on `from_source()` shows only its
+common parameters because reader-specific options travel through `**kwargs`:
+
+```python
+from inspect import signature
+
+from defair.plugin_manager import list_readers, list_sources, load_reader
+
+print(list_sources())
+print(list_readers())
+
+reader = load_reader("msg15nat")
+print(signature(type(reader)))  # calibration, chunks, use_channel_names, ...
+print(signature(reader.read))   # channels, lazy_coordinates, ...
+```
+
+To resolve a reader short name to its product name and EUMETSAT collection ID, use
+`describe_readers()` (or `defair readers` on the command line):
+
+```python
+from defair_data.readers import describe_readers, get_reader_info
+
+print(describe_readers())
+print(get_reader_info("mtg_fci_l2_amv"))  # EO:EUM:DAT:0676
+```
+
+The full table is in `docs/reader-catalogue.md`.
+
+The current API supports `use_channel_names`, but not `use_channel_times`.
+Each reader creates the time coordinates required by its product. Reader
+arguments are validated against the reader's declared parameters, so an
+unrecognised option raises and lists the accepted arguments rather than being
+ignored. This applies to third-party reader plugins too: a `**kwargs` catch-all
+on `read()` no longer widens what a reader accepts, so declare every supported
+option by name.
+
+## Documentation
+
+- [Getting started](docs/what-is-defair.md): what DEFAIR is, installation, a first product and a first workflow
+- [Data loading, S3, streaming, and reader options](docs/data-loading.md)
+- [Workflow examples](docs/workflow-examples.md)
+- [Dask cluster recommendations](docs/dask-cluster-recommendations.md)
+- [Performance benchmarks](docs/benchmarks.md)
+- [Demonstration notebooks](docs/demos/)
+- [Collocation AI use case](packages/defair-ai-demo/msg_mtg_era5_collocation_ai_usecase.ipynb),
+  the notebook that puts MSG, MTG and ERA5 on one grid and trains a cloud-mask model on it
+- [Reader](docs/reader-plugins.md), [writer](docs/writer-plugins.md), and
+  [transformation](docs/transformation-plugins.md) plugin development
+
+The command-line entry point also lists the installed commands and options:
+
+```bash
+defair --help
+```
+
+## Logging
+
+Set logging with CLI flags or environment variables:
+
+```bash
+defair --log-level DEBUG version
+defair --log-json version
+defair --log-module-level "defair_data:DEBUG,defair_ops:WARNING" version
+
+export DEFAIR_LOG_LEVEL=INFO
+export DEFAIR_LOG_JSON=true
+```
+
+Python callers can configure logging directly:
+
+```python
+from defair.logging import setup_logging
+
+setup_logging(log_level="INFO", json_output=False)
+```
+
+## Development
+
+The uv workspace contains three publishable packages:
+
+- `defair` (`src/defair/`): CLI and workflow orchestration
+- `defair-data` (`packages/defair-data/`): data sources, readers, and writers
+- `defair-ops` (`packages/defair-ops/`): transformations and Dask management
+
+These are mutually dependent rather than strictly layered: each imports the other two, so each
+declares the other two, and installing any one of them pulls in the rest. The coupling exists
+because the shared kernel — the entry-point plugin manager, `CFHistoryMixin`, kwargs validation
+and logging — lives in `defair` rather than in a leaf package, so the lower-level packages call
+back up into it. A new cross-package import therefore has to be declared in that package's
+`pyproject.toml`, even though a workspace `uv sync` satisfies it either way.
+
+Common development commands:
+
+```bash
+make install
+make check
+make test
+make docs
+```
+
+Add a dependency to a workspace package with:
+
+```bash
+uv add --package <defair|defair-data|defair-ops> <dependency_name>
+```
+
+All Python source files require Apache 2.0 license headers. Run
+`make headers-check` to validate them or `make headers-add` to add missing
+headers.
+
+## Release maintenance
+
+Build all workspace packages with:
+
+```bash
+uv build --all-packages
+```
+
+Version commands use uv's workspace support:
+
+```bash
+uv version --package <defair|defair-data|defair-ops> --bump <major|minor|patch|rc|stable>
+```
+
+For a patch to an older release, merge the fix to `main`, create a release
+branch from the target tag, cherry-pick the fix, update package versions, and
+tag the patched release.
+
+## Building the documentation
+
+Build the local Material for MkDocs site with:
+
+```bash
+make docs
+```
+
+To generate the DEDL ReadTheDocs/Sphinx source tree, run:
+
+```bash
+uv run python scripts/generate_docs.py path/to/target/directory
+```
+
+[![coverage report](https://gitlab.eumetsat.int/defair/defair-core/badges/main/coverage.svg)](https://gitlab.eumetsat.int/defair/defair-core/-/commits/main)