egms-client 0.1.0__tar.gz

egms_client-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 [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.
+

egms_client-0.1.0/PKG-INFO

@@ -0,0 +1,141 @@
+Metadata-Version: 2.4
+Name: egms-client
+Version: 0.1.0
+Summary: Client for the EGMS archive: CLMS service-key auth, tile search and download, Ortho L3 mosaics
+Keywords: egms,copernicus,insar,ground motion,sentinel-1,subsidence,landslide,clms
+Author: Giuseppe Zileni
+Author-email: Giuseppe Zileni <giuseppe.zileni@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: GIS
+Classifier: Framework :: AsyncIO
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Dist: cryptography>=43
+Requires-Dist: httpx>=0.27
+Requires-Dist: numpy>=2.0 ; extra == 'raster'
+Requires-Dist: pyproj>=3.6 ; extra == 'raster'
+Requires-Dist: rasterio>=1.4 ; extra == 'raster'
+Requires-Python: >=3.12
+Project-URL: Homepage, https://github.com/agent-engineering-studio/egms-client
+Project-URL: Issues, https://github.com/agent-engineering-studio/egms-client/issues
+Project-URL: Changelog, https://github.com/agent-engineering-studio/egms-client/blob/main/CHANGELOG.md
+Provides-Extra: raster
+Description-Content-Type: text/markdown
+
+# egms-client
+
+Async Python client for the archive of [EGMS](https://egms.land.copernicus.eu/),
+the European Ground Motion Service (Copernicus Land Monitoring Service):
+ground velocity from Sentinel-1 InSAR over all of Europe.
+
+- **Authentication with a CLMS service key**: no browser, no copied links.
+- **Search and download of Ortho L3 tiles** (100 m, vertical and east-west),
+  keeping only the mean-velocity GeoTIFF, cached on disk.
+- **Mosaics** of tiles over any rectangle, with no resampling (extra `raster`).
+
+[![ci](https://github.com/agent-engineering-studio/egms-client/actions/workflows/ci.yml/badge.svg)](https://github.com/agent-engineering-studio/egms-client/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/egms-client)](https://pypi.org/project/egms-client/)
+
+## Why a library
+
+The EGMS Explorer is built for clicking. The archive behind it has an API,
+but the parts that matter are undocumented, and each one fails quietly:
+
+| You try | What happens |
+|---|---|
+| any call without a login | HTTP **200** with `{"status": false, "message": "Please log in…"}` |
+| the `id` in a download link as a credential | it is the id of a **search**, and it expires: HTTP 401 |
+| a tile at sea | `status: false` and `Invalid tile ID`, not an empty search |
+| building the file name yourself | the trailing `_1` is a sub-release: read it from the hit |
+| a malformed token assertion | HTTP **500** `DecodeError`, not 401: retries won't help |
+| comparing CRS by name | four tiles of 2020-2025 say `IGNF:ETRS89LAEA`, not `EPSG:3035` |
+| expecting 2021-2025 after 2020-2024 | the next release was 2020-2025: windows grow |
+
+All checked against the live archive on 3 November 2026.
+
+## Install
+
+```bash
+pip install egms-client           # auth, search, download
+pip install "egms-client[raster]" # + mosaics (numpy, rasterio, pyproj)
+```
+
+## Credentials
+
+Create a service key at [land.copernicus.eu](https://land.copernicus.eu/):
+EU Login, profile, **API Tokens**, *Create new token*. You get a JSON file
+with `client_id`, `user_id`, `private_key` and `token_uri`. It does not
+expire; keep it out of your repository.
+
+## Use
+
+```python
+import asyncio
+from pathlib import Path
+
+import httpx
+
+from egms_client import EgmsArchive, ServiceKey, tiles_for_bounds
+from egms_client.mosaic import mosaic
+
+key = ServiceKey.from_json(Path("clms-service-key.json").read_text())
+
+
+async def main() -> None:
+    async with httpx.AsyncClient(timeout=120) as client:
+        archive = EgmsArchive(client, key)
+        print(await archive.releases())  # ['2020-2024', '2020-2025']
+
+        # Rectangle in EPSG:3035 metres
+        bounds = dict(minx=4_700_000, miny=1_900_000, maxx=4_799_999, maxy=1_999_999)
+        tiffs = []
+        for tile in tiles_for_bounds(*bounds.values()):
+            path = await archive.fetch_tile(tile, "U", "2020-2025", Path("egms"))
+            if path is not None:  # None: the tile is at sea or not covered
+                tiffs.append(path)
+
+    vertical = mosaic(tiffs, **bounds)
+    print(vertical.values.shape, vertical.left, vertical.top)  # (1000, 1000) 4700000.0 2000000.0
+
+
+asyncio.run(main())
+```
+
+`fetch_tile` keeps the GeoTIFF (~4 MB) and drops the ~60 MB ZIP. It
+remembers both outcomes in the directory (the file, or an `…absent`
+marker), so running it again for a whole country sends no request. The
+token is renewed five minutes before its hour runs out.
+
+### Bring your own HTTP
+
+Everything `EgmsArchive` does is also exposed as pure functions, for
+callers with their own HTTP and retry layer: `token_request` /
+`parse_token`, `search_body` / `parse_search` / `latest_hit`,
+`parse_releases`, `download_url` / `check_download` / `extract_tiff`.
+
+## Data licence
+
+EGMS is © European Union, Copernicus Land Monitoring Service, free and
+open under the [Copernicus data policy](https://land.copernicus.eu/en/data-policy):
+anything you publish from it must credit the source.
+
+Extracted from [Limen](https://github.com/agent-engineering-studio/limen),
+which uses the vertical and east-west velocities per 1 km cell as ground
+motion features for landslide risk.
+
+## Development
+
+```bash
+uv sync
+make check
+```
+
+## License
+
+Code: [Apache-2.0](./LICENSE).

egms_client-0.1.0/README.md

@@ -0,0 +1,111 @@
+# egms-client
+
+Async Python client for the archive of [EGMS](https://egms.land.copernicus.eu/),
+the European Ground Motion Service (Copernicus Land Monitoring Service):
+ground velocity from Sentinel-1 InSAR over all of Europe.
+
+- **Authentication with a CLMS service key**: no browser, no copied links.
+- **Search and download of Ortho L3 tiles** (100 m, vertical and east-west),
+  keeping only the mean-velocity GeoTIFF, cached on disk.
+- **Mosaics** of tiles over any rectangle, with no resampling (extra `raster`).
+
+[![ci](https://github.com/agent-engineering-studio/egms-client/actions/workflows/ci.yml/badge.svg)](https://github.com/agent-engineering-studio/egms-client/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/egms-client)](https://pypi.org/project/egms-client/)
+
+## Why a library
+
+The EGMS Explorer is built for clicking. The archive behind it has an API,
+but the parts that matter are undocumented, and each one fails quietly:
+
+| You try | What happens |
+|---|---|
+| any call without a login | HTTP **200** with `{"status": false, "message": "Please log in…"}` |
+| the `id` in a download link as a credential | it is the id of a **search**, and it expires: HTTP 401 |
+| a tile at sea | `status: false` and `Invalid tile ID`, not an empty search |
+| building the file name yourself | the trailing `_1` is a sub-release: read it from the hit |
+| a malformed token assertion | HTTP **500** `DecodeError`, not 401: retries won't help |
+| comparing CRS by name | four tiles of 2020-2025 say `IGNF:ETRS89LAEA`, not `EPSG:3035` |
+| expecting 2021-2025 after 2020-2024 | the next release was 2020-2025: windows grow |
+
+All checked against the live archive on 3 November 2026.
+
+## Install
+
+```bash
+pip install egms-client           # auth, search, download
+pip install "egms-client[raster]" # + mosaics (numpy, rasterio, pyproj)
+```
+
+## Credentials
+
+Create a service key at [land.copernicus.eu](https://land.copernicus.eu/):
+EU Login, profile, **API Tokens**, *Create new token*. You get a JSON file
+with `client_id`, `user_id`, `private_key` and `token_uri`. It does not
+expire; keep it out of your repository.
+
+## Use
+
+```python
+import asyncio
+from pathlib import Path
+
+import httpx
+
+from egms_client import EgmsArchive, ServiceKey, tiles_for_bounds
+from egms_client.mosaic import mosaic
+
+key = ServiceKey.from_json(Path("clms-service-key.json").read_text())
+
+
+async def main() -> None:
+    async with httpx.AsyncClient(timeout=120) as client:
+        archive = EgmsArchive(client, key)
+        print(await archive.releases())  # ['2020-2024', '2020-2025']
+
+        # Rectangle in EPSG:3035 metres
+        bounds = dict(minx=4_700_000, miny=1_900_000, maxx=4_799_999, maxy=1_999_999)
+        tiffs = []
+        for tile in tiles_for_bounds(*bounds.values()):
+            path = await archive.fetch_tile(tile, "U", "2020-2025", Path("egms"))
+            if path is not None:  # None: the tile is at sea or not covered
+                tiffs.append(path)
+
+    vertical = mosaic(tiffs, **bounds)
+    print(vertical.values.shape, vertical.left, vertical.top)  # (1000, 1000) 4700000.0 2000000.0
+
+
+asyncio.run(main())
+```
+
+`fetch_tile` keeps the GeoTIFF (~4 MB) and drops the ~60 MB ZIP. It
+remembers both outcomes in the directory (the file, or an `…absent`
+marker), so running it again for a whole country sends no request. The
+token is renewed five minutes before its hour runs out.
+
+### Bring your own HTTP
+
+Everything `EgmsArchive` does is also exposed as pure functions, for
+callers with their own HTTP and retry layer: `token_request` /
+`parse_token`, `search_body` / `parse_search` / `latest_hit`,
+`parse_releases`, `download_url` / `check_download` / `extract_tiff`.
+
+## Data licence
+
+EGMS is © European Union, Copernicus Land Monitoring Service, free and
+open under the [Copernicus data policy](https://land.copernicus.eu/en/data-policy):
+anything you publish from it must credit the source.
+
+Extracted from [Limen](https://github.com/agent-engineering-studio/limen),
+which uses the vertical and east-west velocities per 1 km cell as ground
+motion features for landslide risk.
+
+## Development
+
+```bash
+uv sync
+make check
+```
+
+## License
+
+Code: [Apache-2.0](./LICENSE).

egms_client-0.1.0/pyproject.toml

@@ -0,0 +1,118 @@
+[project]
+name = "egms-client"
+version = "0.1.0"
+description = "Client for the EGMS archive: CLMS service-key auth, tile search and download, Ortho L3 mosaics"
+readme = "README.md"
+keywords = [
+    "egms",
+    "copernicus",
+    "insar",
+    "ground motion",
+    "sentinel-1",
+    "subsidence",
+    "landslide",
+    "clms",
+]
+requires-python = ">=3.12"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Science/Research",
+    "Topic :: Scientific/Engineering :: GIS",
+    "Framework :: AsyncIO",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Typing :: Typed",
+]
+dependencies = [
+    "cryptography>=43",
+    "httpx>=0.27",
+]
+
+[[project.authors]]
+name = "Giuseppe Zileni"
+email = "giuseppe.zileni@gmail.com"
+
+[project.optional-dependencies]
+raster = [
+    "numpy>=2.0",
+    "pyproj>=3.6",
+    "rasterio>=1.4",
+]
+
+[project.urls]
+Homepage = "https://github.com/agent-engineering-studio/egms-client"
+Issues = "https://github.com/agent-engineering-studio/egms-client/issues"
+Changelog = "https://github.com/agent-engineering-studio/egms-client/blob/main/CHANGELOG.md"
+
+[build-system]
+requires = ["uv_build>=0.13.6,<0.14"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "mypy>=1.13",
+    "numpy>=2.0",
+    "pyproj>=3.6",
+    "rasterio>=1.4",
+    "pytest>=8.3",
+    "pytest-cov>=6.0",
+    "ruff>=0.8",
+]
+
+[tool.ruff]
+line-length = 100
+target-version = "py312"
+
+[tool.ruff.lint]
+select = [
+    "E",
+    "F",
+    "W",
+    "I",
+    "N",
+    "UP",
+    "B",
+    "C4",
+    "SIM",
+    "ARG",
+    "PTH",
+    "RUF",
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**" = [
+    "ARG",
+    "B018",
+]
+
+[tool.mypy]
+strict = true
+python_version = "3.12"
+files = [
+    "src",
+    "tests",
+]
+warn_unused_ignores = true
+warn_redundant_casts = true
+
+[[tool.mypy.overrides]]
+module = [
+    "rasterio.*",
+    "pyproj.*",
+]
+ignore_missing_imports = true
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "--strict-markers"
+
+[tool.coverage.run]
+source = ["egms_client"]
+
+[tool.coverage.report]
+fail_under = 90
+show_missing = true

egms_client-0.1.0/pyproject.toml.orig

@@ -0,0 +1,86 @@
+[project]
+name = "egms-client"
+version = "0.1.0"
+description = "Client for the EGMS archive: CLMS service-key auth, tile search and download, Ortho L3 mosaics"
+readme = "README.md"
+keywords = ["egms", "copernicus", "insar", "ground motion", "sentinel-1", "subsidence", "landslide", "clms"]
+requires-python = ">=3.12"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [
+    { name = "Giuseppe Zileni", email = "giuseppe.zileni@gmail.com" },
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Science/Research",
+    "Topic :: Scientific/Engineering :: GIS",
+    "Framework :: AsyncIO",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Typing :: Typed",
+]
+dependencies = [
+    "cryptography>=43",
+    "httpx>=0.27",
+]
+
+[project.optional-dependencies]
+raster = [
+    "numpy>=2.0",
+    "pyproj>=3.6",
+    "rasterio>=1.4",
+]
+
+[project.urls]
+Homepage = "https://github.com/agent-engineering-studio/egms-client"
+Issues = "https://github.com/agent-engineering-studio/egms-client/issues"
+Changelog = "https://github.com/agent-engineering-studio/egms-client/blob/main/CHANGELOG.md"
+
+[build-system]
+requires = ["uv_build>=0.13.6,<0.14"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "mypy>=1.13",
+    "numpy>=2.0",
+    "pyproj>=3.6",
+    "rasterio>=1.4",
+    "pytest>=8.3",
+    "pytest-cov>=6.0",
+    "ruff>=0.8",
+]
+
+[tool.ruff]
+line-length = 100
+target-version = "py312"
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "N", "UP", "B", "C4", "SIM", "ARG", "PTH", "RUF"]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**" = ["ARG", "B018"]
+
+[tool.mypy]
+strict = true
+python_version = "3.12"
+files = ["src", "tests"]
+warn_unused_ignores = true
+warn_redundant_casts = true
+
+[[tool.mypy.overrides]]
+module = ["rasterio.*", "pyproj.*"]
+ignore_missing_imports = true
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "--strict-markers"
+
+[tool.coverage.run]
+source = ["egms_client"]
+
+[tool.coverage.report]
+fail_under = 90
+show_missing = true

egms_client-0.1.0/src/egms_client/__init__.py

@@ -0,0 +1,62 @@
+"""Client for the EGMS archive (European Ground Motion Service)."""
+
+from importlib.metadata import version
+
+from egms_client.archive import (
+    ARCHIVE_URL,
+    COMPONENTS,
+    PRODUCT_TYPES,
+    TILE_SIZE_M,
+    Component,
+    Hit,
+    Search,
+    Tile,
+    api_release,
+    check_download,
+    download_url,
+    extract_tiff,
+    file_release,
+    latest_hit,
+    parse_releases,
+    parse_search,
+    search_body,
+    tile_id,
+    tile_prefix,
+    tiles_for_bounds,
+)
+from egms_client.auth import ServiceKey, Token, assertion, parse_token, token_request
+from egms_client.client import EgmsArchive
+from egms_client.errors import EgmsError
+
+__version__ = version("egms-client")
+
+__all__ = [
+    "ARCHIVE_URL",
+    "COMPONENTS",
+    "PRODUCT_TYPES",
+    "TILE_SIZE_M",
+    "Component",
+    "EgmsArchive",
+    "EgmsError",
+    "Hit",
+    "Search",
+    "ServiceKey",
+    "Tile",
+    "Token",
+    "__version__",
+    "api_release",
+    "assertion",
+    "check_download",
+    "download_url",
+    "extract_tiff",
+    "file_release",
+    "latest_hit",
+    "parse_releases",
+    "parse_search",
+    "parse_token",
+    "search_body",
+    "tile_id",
+    "tile_prefix",
+    "tiles_for_bounds",
+    "token_request",
+]

egms_client-0.1.0/src/egms_client/archive.py

@@ -0,0 +1,187 @@
+"""Searching and downloading Ortho L3 tiles from the EGMS archive.
+
+The Ortho L3 product is the ground velocity resampled on a 100 m grid in
+EPSG:3035 (LAEA Europe), in 100 km tiles, one per component: ``U``
+(vertical) and ``E`` (east-west). A tile is named by its lower-left corner
+in hundreds of kilometres: E47N19 covers 4,700,000-4,800,000 m east and
+1,900,000-2,000,000 m north. Each ZIP (~60 MB) holds a CSV of time series
+(~245 MB once unpacked) and a GeoTIFF of the mean velocity (~4 MB).
+
+Downloading needs the ``id`` of a **search**, not the bearer token: the
+download URL carries ``?id=<search id>``, and that id expires. An expired or
+unknown id is answered with HTTP 401 and a plain-text message.
+
+Verified against the live archive on 2026-11-03:
+
+* releases are named ``2020-2025`` in the API and ``2020_2025`` in file
+  names; a release is a window of years, and a new one may extend the window
+  rather than slide it (2020-2024 was followed by 2020-2025, not 2021-2025);
+* a tile at sea or outside coverage is answered with ``status: false`` and
+  ``Invalid tile ID: 'E40N15'``, not with an empty search;
+* each hit carries its own ``filename`` and ``version`` (``2020_2025_1``):
+  the trailing number is a sub-release, so read the name from the hit
+  instead of building it.
+"""
+
+from __future__ import annotations
+
+import io
+import json
+import math
+import zipfile
+from dataclasses import dataclass
+from typing import Any, Literal
+
+from egms_client.errors import EgmsError
+
+ARCHIVE_URL = "https://egms.land.copernicus.eu/insar-api/archive"
+
+Component = Literal["U", "E"]
+COMPONENTS: tuple[Component, ...] = ("U", "E")
+PRODUCT_TYPES: dict[Component, str] = {"U": "ORTHO-UP", "E": "ORTHO-EAST"}
+
+#: Side of an Ortho L3 tile, in EPSG:3035 metres.
+TILE_SIZE_M = 100_000
+
+#: (E, N): the lower-left corner in hundreds of kilometres.
+Tile = tuple[int, int]
+
+
+@dataclass(frozen=True, slots=True)
+class Hit:
+    """One downloadable file of a search."""
+
+    filename: str
+    filesize: int
+    tile_id: str
+    release: str
+    version: str
+    product_type: str
+
+    @property
+    def stem(self) -> str:
+        """The file name without ``.zip``: also the name of the GeoTIFF inside."""
+        return self.filename.removesuffix(".zip")
+
+
+@dataclass(frozen=True, slots=True)
+class Search:
+    """A search id and its hits. The id is what the download URL needs."""
+
+    id: str
+    hits: list[Hit]
+
+
+def tile_id(tile: Tile) -> str:
+    """``(47, 19)`` → ``"E47N19"``."""
+    e, n = tile
+    return f"E{e}N{n}"
+
+
+def tiles_for_bounds(minx: float, miny: float, maxx: float, maxy: float) -> list[Tile]:
+    """The tiles covering a rectangle in EPSG:3035 metres."""
+    e0, e1 = math.floor(minx / TILE_SIZE_M), math.floor(maxx / TILE_SIZE_M)
+    n0, n1 = math.floor(miny / TILE_SIZE_M), math.floor(maxy / TILE_SIZE_M)
+    return [(e, n) for e in range(e0, e1 + 1) for n in range(n0, n1 + 1)]
+
+
+def api_release(release: str) -> str:
+    """``2020_2025`` (file names) or ``2020-2025`` → ``2020-2025`` (the API's form)."""
+    return release.replace("_", "-")
+
+
+def file_release(release: str) -> str:
+    """``2020-2025`` or ``2020_2025`` → ``2020_2025`` (the file names' form)."""
+    return release.replace("-", "_")
+
+
+def tile_prefix(tile: Tile, component: Component, release: str) -> str:
+    """The file name up to the sub-release: ``EGMS_L3_E47N19_100km_U_2020_2025_``."""
+    return f"EGMS_L3_{tile_id(tile)}_100km_{component}_{file_release(release)}_"
+
+
+def search_body(tile: Tile, component: Component, release: str) -> dict[str, Any]:
+    """The JSON body of ``POST {archive}/search`` for one Ortho L3 tile."""
+    return {
+        "tileId": tile_id(tile),
+        "releases": [api_release(release)],
+        "levels": ["L3"],
+        "productType": PRODUCT_TYPES[component],
+    }
+
+
+def parse_releases(body: bytes | str) -> list[str]:
+    """The release names, oldest first. :class:`EgmsError` when not logged in."""
+    data = _json(body)
+    if not isinstance(data, list):
+        raise EgmsError(f"EGMS archive refused the release list: {_message(data)}")
+    return sorted(str(r) for r in data)
+
+
+def parse_search(body: bytes | str) -> Search | None:
+    """The search, or ``None`` when the tile does not exist (sea, no coverage).
+
+    Raises :class:`EgmsError` for any other refusal, such as a missing login.
+    """
+    data = _json(body)
+    if not isinstance(data, dict):
+        raise EgmsError(f"EGMS archive returned an unexpected search: {str(body)[:200]}")
+    if not data.get("status"):
+        if str(data.get("message") or "").startswith("Invalid tile ID"):
+            return None
+        raise EgmsError(f"EGMS archive refused the search: {_message(data)}")
+    hits = [
+        Hit(
+            filename=str(h["filename"]),
+            filesize=int(h.get("filesize") or 0),
+            tile_id=str(h.get("tileId") or ""),
+            release=str(h.get("release") or ""),
+            version=str(h.get("version") or ""),
+            product_type=str(h.get("productType") or ""),
+        )
+        for h in data.get("hits") or []
+    ]
+    return Search(id=str(data["id"]), hits=hits)
+
+
+def latest_hit(search: Search) -> Hit | None:
+    """The hit with the highest sub-release, or ``None`` if there is none."""
+    return max(search.hits, key=lambda h: _sub_release(h.version), default=None)
+
+
+def download_url(archive_url: str, hit: Hit) -> str:
+    """The URL to GET with ``params={"id": search.id}``."""
+    return f"{archive_url.rstrip('/')}/download/{hit.filename}"
+
+
+def check_download(status_code: int, body: bytes) -> bytes:
+    """The ZIP, or :class:`EgmsError` (401 means the search id expired: search again)."""
+    if status_code != 200:
+        text = body[:200].decode("utf-8", "replace")
+        raise EgmsError(f"EGMS download refused (HTTP {status_code}): {text}")
+    return body
+
+
+def extract_tiff(archive: bytes, hit: Hit) -> bytes:
+    """The mean-velocity GeoTIFF from a tile's ZIP; the CSV is left inside."""
+    with zipfile.ZipFile(io.BytesIO(archive)) as z:
+        try:
+            return z.read(f"{hit.stem}.tiff")
+        except KeyError as exc:
+            raise EgmsError(f"{hit.filename} has no {hit.stem}.tiff: {z.namelist()}") from exc
+
+
+def _sub_release(version: str) -> int:
+    tail = version.rsplit("_", 1)[-1]
+    return int(tail) if tail.isdigit() else 0
+
+
+def _json(body: bytes | str) -> Any:
+    try:
+        return json.loads(body)
+    except ValueError as exc:
+        raise EgmsError(f"EGMS archive did not return JSON: {str(body)[:200]!r}") from exc
+
+
+def _message(data: Any) -> str:
+    return str(data.get("message")) if isinstance(data, dict) else str(data)[:200]

egms_client-0.1.0/src/egms_client/auth.py

@@ -0,0 +1,116 @@
+"""Access tokens from a CLMS service key.
+
+The EGMS archive answers ``{"status": false, "message": "Please log in to
+perform archive API calls."}`` to every anonymous call, releases included.
+The way in that needs no browser is a **service key** of the Copernicus Land
+Monitoring Service: land.copernicus.eu, EU Login, profile → "API Tokens" →
+"Create new token". It is a JSON document with ``client_id``, ``user_id``,
+``private_key`` (RSA, PEM) and ``token_uri``, and it does not expire.
+
+The key signs a short JWT (RS256), which the token endpoint exchanges for a
+bearer token valid one hour (OAuth 2.0 JWT bearer grant, RFC 7523).
+
+A malformed assertion is answered with **HTTP 500** and a ``DecodeError``,
+not 401: a retry policy on 5xx will retry it pointlessly.
+"""
+
+from __future__ import annotations
+
+import base64
+import json
+from dataclasses import dataclass
+from typing import Any
+
+from egms_client.errors import EgmsError
+
+#: Lifetime of the signed assertion, in seconds.
+ASSERTION_LIFETIME = 3600
+GRANT_TYPE = "urn:ietf:params:oauth:grant-type:jwt-bearer"
+
+_FIELDS = ("client_id", "user_id", "private_key", "token_uri")
+
+
+@dataclass(frozen=True, slots=True)
+class ServiceKey:
+    """A CLMS service key, as downloaded from the land.copernicus.eu profile."""
+
+    client_id: str
+    user_id: str
+    private_key: str
+    token_uri: str
+
+    @classmethod
+    def from_json(cls, text: str) -> ServiceKey:
+        """Parse the JSON document; raise ``ValueError`` if a field is missing or empty."""
+        data = json.loads(text)
+        if not isinstance(data, dict):
+            raise ValueError("a CLMS service key is a JSON object")
+        missing = [f for f in _FIELDS if not data.get(f)]
+        if missing:
+            raise ValueError(f"CLMS service key without {', '.join(missing)}")
+        return cls(**{f: str(data[f]) for f in _FIELDS})
+
+    def __repr__(self) -> str:
+        return f"ServiceKey(client_id={self.client_id!r}, user_id={self.user_id!r}, private_key=…)"
+
+
+@dataclass(frozen=True, slots=True)
+class Token:
+    """A bearer token and the Unix time it expires at."""
+
+    access_token: str
+    expires_at: float
+
+    def headers(self) -> dict[str, str]:
+        return {"Authorization": f"Bearer {self.access_token}", "Accept": "application/json"}
+
+    def __repr__(self) -> str:
+        return f"Token(access_token=…, expires_at={self.expires_at})"
+
+
+def assertion(key: ServiceKey, *, now: int, lifetime: int = ASSERTION_LIFETIME) -> str:
+    """The RS256 JWT the service key signs to ask for a token."""
+    from cryptography.hazmat.primitives import hashes, serialization
+    from cryptography.hazmat.primitives.asymmetric import padding, rsa
+
+    header = _b64(json.dumps({"alg": "RS256", "typ": "JWT"}).encode())
+    claims = _b64(
+        json.dumps(
+            {
+                "iss": key.client_id,
+                "sub": key.user_id,
+                "aud": key.token_uri,
+                "iat": now,
+                "exp": now + lifetime,
+            }
+        ).encode()
+    )
+    private = serialization.load_pem_private_key(key.private_key.encode(), password=None)
+    if not isinstance(private, rsa.RSAPrivateKey):
+        raise ValueError("the CLMS service key is not an RSA key")
+    signature = _b64(private.sign(header + b"." + claims, padding.PKCS1v15(), hashes.SHA256()))
+    return (header + b"." + claims + b"." + signature).decode()
+
+
+def token_request(key: ServiceKey, *, now: int) -> dict[str, str]:
+    """The form body to POST to ``key.token_uri``."""
+    return {"grant_type": GRANT_TYPE, "assertion": assertion(key, now=now)}
+
+
+def parse_token(status_code: int, body: bytes | str, *, now: float) -> Token:
+    """The token from the endpoint's answer; :class:`EgmsError` if it was refused."""
+    try:
+        data: Any = json.loads(body)
+    except ValueError:
+        data = None
+    if status_code != 200 or not isinstance(data, dict) or "access_token" not in data:
+        detail = data.get("message") if isinstance(data, dict) else str(body)[:200]
+        raise EgmsError(f"CLMS token refused (HTTP {status_code}): {detail}")
+    return Token(
+        access_token=str(data["access_token"]),
+        expires_at=now + float(data.get("expires_in", ASSERTION_LIFETIME)),
+    )
+
+
+def _b64(data: bytes) -> bytes:
+    return base64.urlsafe_b64encode(data).rstrip(b"=")

egms_client-0.1.0/src/egms_client/client.py

@@ -0,0 +1,119 @@
+"""An async client over :mod:`egms_client.auth` and :mod:`egms_client.archive`.
+
+It takes your ``httpx.AsyncClient``: timeouts, retries, proxies and pooling
+stay yours. HTTP errors propagate; refusals the archive disguises as a 200
+raise :class:`~egms_client.errors.EgmsError`.
+"""
+
+from __future__ import annotations
+
+import time
+from collections.abc import Callable
+from pathlib import Path
+from typing import TYPE_CHECKING
+
+from egms_client.archive import (
+    ARCHIVE_URL,
+    Component,
+    Search,
+    Tile,
+    check_download,
+    download_url,
+    extract_tiff,
+    latest_hit,
+    parse_releases,
+    parse_search,
+    search_body,
+    tile_prefix,
+)
+from egms_client.auth import ServiceKey, Token, parse_token, token_request
+
+if TYPE_CHECKING:
+    import httpx
+
+#: Renew the token this many seconds before it expires: a national download
+#: lasts longer than the token's hour.
+RENEW_MARGIN_S = 300
+
+
+class EgmsArchive:
+    """Releases, searches and Ortho L3 tiles, with a token renewed as needed."""
+
+    def __init__(
+        self,
+        client: httpx.AsyncClient,
+        key: ServiceKey,
+        *,
+        archive_url: str = ARCHIVE_URL,
+        clock: Callable[[], float] = time.time,
+    ) -> None:
+        self._client = client
+        self._key = key
+        self._archive = archive_url.rstrip("/")
+        self._clock = clock
+        self._token: Token | None = None
+
+    async def token(self) -> Token:
+        """A valid bearer token, asking for a new one when the current is about to expire."""
+        now = self._clock()
+        if self._token is None or now > self._token.expires_at - RENEW_MARGIN_S:
+            response = await self._client.post(
+                self._key.token_uri,
+                data=token_request(self._key, now=int(now)),
+                headers={"Accept": "application/json"},
+            )
+            self._token = parse_token(response.status_code, response.content, now=now)
+        return self._token
+
+    async def releases(self) -> list[str]:
+        """The published releases, oldest first (``["2020-2024", "2020-2025"]``)."""
+        token = await self.token()
+        response = await self._client.get(f"{self._archive}/releases", headers=token.headers())
+        response.raise_for_status()
+        return parse_releases(response.content)
+
+    async def search(self, tile: Tile, component: Component, release: str) -> Search | None:
+        """Search one Ortho L3 tile; ``None`` if the tile does not exist."""
+        token = await self.token()
+        response = await self._client.post(
+            f"{self._archive}/search",
+            headers=token.headers(),
+            json=search_body(tile, component, release),
+        )
+        response.raise_for_status()
+        return parse_search(response.content)
+
+    async def fetch_tile(
+        self, tile: Tile, component: Component, release: str, directory: Path
+    ) -> Path | None:
+        """The tile's mean-velocity GeoTIFF in ``directory``, downloaded if missing.
+
+        ``None`` when the tile does not exist. Both outcomes are remembered in
+        ``directory`` (the GeoTIFF, or an ``…absent`` marker), so running it
+        again for a whole country asks the archive nothing.
+        """
+        prefix = tile_prefix(tile, component, release)
+        cached = sorted(directory.glob(f"{prefix}*.tiff"))
+        if cached:
+            return cached[-1]
+        marker = directory / f"{prefix}absent"
+        if marker.exists():
+            return None
+        directory.mkdir(parents=True, exist_ok=True)
+        search = await self.search(tile, component, release)
+        hit = latest_hit(search) if search is not None else None
+        if search is None or hit is None:
+            marker.touch()
+            return None
+        response = await self._client.get(
+            download_url(self._archive, hit), params={"id": search.id}
+        )
+        if response.status_code == 404:
+            marker.touch()
+            return None
+        tiff = extract_tiff(check_download(response.status_code, response.content), hit)
+        path = directory / f"{hit.stem}.tiff"
+        partial = path.with_suffix(".part")
+        partial.write_bytes(tiff)
+        partial.rename(path)
+        return path

egms_client-0.1.0/src/egms_client/errors.py

@@ -0,0 +1,6 @@
+class EgmsError(Exception):
+    """The EGMS archive or the CLMS token endpoint answered, but not with what was asked.
+
+    The archive reports most failures as HTTP 200 with ``{"status": false,
+    "message": ...}``, so a status check alone never sees them.
+    """

egms_client-0.1.0/src/egms_client/mosaic.py

@@ -0,0 +1,83 @@
+"""Ortho L3 tiles pasted onto one grid. Needs the ``raster`` extra.
+
+The tiles sit on a common 100 m grid in EPSG:3035, so a mosaic is a copy of
+each tile into its place, with no resampling.
+
+Some tiles declare their CRS as ``IGNF:ETRS89LAEA`` instead of
+``EPSG:3035``: the same projection under the French IGN's name. In the
+2020-2025 release that is E43N26, E44N26, E45N26 and E46N26 (in 2020-2024,
+E42N26 and E43N26). Comparing CRS by name rejects them; :func:`is_laea`
+compares the parameters.
+"""
+
+from __future__ import annotations
+
+import math
+import warnings
+from collections.abc import Iterable
+from dataclasses import dataclass
+from pathlib import Path
+from typing import Any
+
+#: Pixel size of the Ortho L3 product, in metres.
+PIXEL_M = 100.0
+
+
+@dataclass(frozen=True, slots=True)
+class Mosaic:
+    """A float32 array (NaN where there is no data) and its upper-left corner."""
+
+    values: Any
+    left: float
+    top: float
+    pixel: float = PIXEL_M
+
+
+def is_laea(crs: Any) -> bool:
+    """True if a rasterio CRS is LAEA Europe (EPSG:3035) by its parameters."""
+    from pyproj import CRS
+
+    with warnings.catch_warnings():
+        # pyproj warns that a PROJ string drops information: only the
+        # parameters are wanted here.
+        warnings.simplefilter("ignore", UserWarning)
+        return bool(CRS.from_wkt(crs.to_wkt()).to_proj4() == CRS.from_epsg(3035).to_proj4())
+
+
+def mosaic(tiffs: Iterable[Path], *, minx: float, miny: float, maxx: float, maxy: float) -> Mosaic:
+    """Paste the tiles of one component over a rectangle in EPSG:3035 metres.
+
+    The rectangle widens to the 100 m grid. Pixels no tile covers, and the
+    tiles' own nodata, are NaN. A tile in another projection raises
+    ``ValueError``.
+    """
+    import numpy as np
+    import rasterio
+
+    x0 = math.floor(minx / PIXEL_M) * PIXEL_M
+    y0 = math.floor(miny / PIXEL_M) * PIXEL_M
+    x1 = math.ceil(maxx / PIXEL_M) * PIXEL_M
+    y1 = math.ceil(maxy / PIXEL_M) * PIXEL_M
+    rows = round((y1 - y0) / PIXEL_M)
+    cols = round((x1 - x0) / PIXEL_M)
+    out = np.full((rows, cols), np.nan, dtype="float32")
+    for path in tiffs:
+        with rasterio.open(path) as src:
+            if not is_laea(src.crs):
+                raise ValueError(f"{path.name}: not LAEA Europe ({src.crs})")
+            band = src.read(1).astype("float32")
+            if src.nodata is not None:
+                band[band == src.nodata] = np.nan
+            col = round((src.bounds.left - x0) / PIXEL_M)
+            row = round((y1 - src.bounds.top) / PIXEL_M)
+        sr, sc = max(0, -row), max(0, -col)
+        dr, dc = max(0, row), max(0, col)
+        h = min(band.shape[0] - sr, rows - dr)
+        w = min(band.shape[1] - sc, cols - dc)
+        if h <= 0 or w <= 0:
+            continue
+        piece = band[sr : sr + h, sc : sc + w]
+        target = out[dr : dr + h, dc : dc + w]
+        valid = ~np.isnan(piece)
+        target[valid] = piece[valid]
+    return Mosaic(values=out, left=x0, top=y1)