stac-processor-gdmsar 0.0.2__tar.gz

stac_processor_gdmsar-0.0.2/LICENCE.txt

@@ -0,0 +1,145 @@
+OPEN LICENCE 2.0/LICENCE OUVERTE 2.0
+
+
+"Reuse" of the "Information" covered by this licence
+
+The "Grantor" grants the "Reuser" the free, non-exclusive right to "Reuse" the
+"Information" subject of this licence, for commercial or non-commercial
+purposes, worldwide and for an unlimited period, in accordance with the
+conditions stated below.
+
+The "Reuser" is free to reuse the "Information":
+
+- To reproduce it, copy it.
+- To adapt, modify, retrieve and transform it in order to create "derived
+  information", products and services.
+- To share, disseminate, redistribute, publish and transmit it.
+- To exploit it for commercial purposes, e.g., by combining it with other
+  information, or by including it in his/her own product or application.
+
+Subject to:
+
+- An acknowledgement of the authorship of the "Information": its source (at
+  least, the name of the "Grantor") and the date of the most recent update of
+  the reused "Information".
+
+Specifically, the "Reuser" may satisfy this condition by pointing, via a
+hypertext link, to the source of the "Information" and so supplying an actual
+acknowledgement of its authorship.
+
+For example:
+
+"Ministry of xxx—Original data downloaded from
+'http://www.data.gouv.fr/fr/datasets/xxx/', updated on 14 February 2017".
+
+This acknowledgement of authorship does not confer any official status on the
+"Reuse" of the "Information", and must not suggest any sort of recognition or
+endorsement on the part of the "Grantor", or any other public entity, of the
+"Reuser" or of their "Reuse".
+
+
+Personal data
+
+The "Information" made available may contain "Personal data" that may be
+subject to "Reuse". If this is the case, the "Grantor" informs the "Reuser"
+about its existence. The "Information" may be freely reused, within the rights
+granted by this licence, subject to compliance with the legal framework
+relating to personal data protection.
+
+
+Intellectual property rights
+
+It is guaranteed to The "Reuser" that potential "Intellectual property rights"
+held by third parties or by the "Grantor" on "Information" do not interfere
+with the rights granted by this licence.
+
+When the "Grantor" holds transferable "Intellectual property rights" on the
+"Information", he/she assigns these to the "Reuser" on a non-exclusive basis,
+free of charge, worldwide, for the entire duration of the "Intellectual
+property rights", and the "Reuser" is free to use the "Information" for any
+purpose that complies with the rights and conditions defined in this licence.
+
+
+Liability
+
+The "Information" is made available as it is produced or received by the
+"Grantor", without any other express or tacit guarantee than those set out in
+this licence. The "Grantor" does not guarantee the absence of errors or
+inaccuracies in the "Information", nor a continuous supply of the
+"Information". He/she cannot be held responsible for any loss, prejudice or
+damage of any kind caused to third parties as a result of the "Reuse".
+
+The "Reuser" is solely responsible for the "Reuse" of the "Information". This
+"Reuse" must not mislead third parties as to the contents of the "Information",
+its source or its date of update.
+
+
+Applicable legislation
+
+This licence is governed by French law.
+
+Compatibility of this licence
+
+This licence has been designed to be compatible with any free licence that at
+least requires an acknowledgement of authorship, and specifically with the
+previous version of this licence as well as with the following licences: United
+Kingdom's "Open Government Licence" (OGL), Creative Commons' "Creative Commons
+Attribution" (CC-BY) and Open Knowledge Foundation's "Open Data Commons
+Attribution" (ODC-BY).
+
+
+Definitions
+
+Within the meaning of this licence, are to be considered as:
+
+- The "Grantor": any person granting the right to "Reuse" "Information" under
+  the rights and conditions set out in this licence.
+- The "Information":
+  - any public information contained in documents disclosed or published by any
+    administration referred to in the first paragraph of Article L. 300-2 of
+    the "Code des relations entre le public et l'administration (CRPA)",
+  - any information made available by any person under the terms and conditions
+    of this licence.
+- The "Reuse": the use of the "Information" for other purposes than those for
+  which it was produced or received.
+- The "Reuser": any person reusing the "Information" in accordance with the
+  conditions of this licence.
+- "Personal data": any information relating to an identified or identifiable
+  natural person who may be identified directly or indirectly. Its "Reuse" is
+  conditional on the respect of the existing legal framework.
+- "Derived information": any new data or information created directly from the
+  "Information" or from a combination of the "Information" and other data or
+  information not subject to this licence.
+- "Intellectual property rights": all rights identified as such under the "Code
+  de la propriété intellectuelle" (including copyright, rights related to
+  copyright, sui generis rights of database producers, etc.).
+
+
+About this licence
+
+This licence is intended to be used by administrations for the reuse of their
+public information. It can also be used by any individual wishing to supply
+"Information" under the conditions defined in this licence.
+
+France has a comprehensive legal framework aiming at the spontaneous
+dissemination by the administrations of their public information in order to
+ensure the widest possible reuse of this information.
+
+The right to "Reuse" the administrations' "Information" is governed by the
+"Code des relations entre le public et l'administration (CRPA)".
+
+This licence facilitates the unrestricted and free of charge reuse of public
+information and is one of the licences which can be used by the administration
+pursuant to the decree issued under article L. 323-2 of the CRPA.
+
+Under the Prime Minister's authority, the Etalab mission is mandated to open up
+the maximum amount of data held by State administrations and public
+institutions. Etalab has drawn up the Open Licence to facilitate the
+unrestricted and free of charge reuse of public information, as defined by
+article L. 321-1 of the CRPA.
+
+This licence is version 2.0 of the Open Licence.
+
+Etalab reserves the right to propose new versions of the Open Licence.
+Nevertheless, "Reusers" may continue to reuse information obtained under this
+licence should they so wish.

stac_processor_gdmsar-0.0.2/PKG-INFO

@@ -0,0 +1,215 @@
+Metadata-Version: 2.4
+Name: stac-processor-gdmsar
+Version: 0.0.2
+Summary: A stac-repository complient processor for GDM-SAR products
+Author-email: Pierre Fontbonne <pierre.fontbonne@uca.fr>, Alexandre Burel <alexandre.burel@cnrs.fr>
+Maintainer-email: Alexandre Burel <alexandre.burel@cnrs.fr>
+License: OPEN LICENCE 2.0/LICENCE OUVERTE 2.0
+        
+        
+        "Reuse" of the "Information" covered by this licence
+        
+        The "Grantor" grants the "Reuser" the free, non-exclusive right to "Reuse" the
+        "Information" subject of this licence, for commercial or non-commercial
+        purposes, worldwide and for an unlimited period, in accordance with the
+        conditions stated below.
+        
+        The "Reuser" is free to reuse the "Information":
+        
+        - To reproduce it, copy it.
+        - To adapt, modify, retrieve and transform it in order to create "derived
+          information", products and services.
+        - To share, disseminate, redistribute, publish and transmit it.
+        - To exploit it for commercial purposes, e.g., by combining it with other
+          information, or by including it in his/her own product or application.
+        
+        Subject to:
+        
+        - An acknowledgement of the authorship of the "Information": its source (at
+          least, the name of the "Grantor") and the date of the most recent update of
+          the reused "Information".
+        
+        Specifically, the "Reuser" may satisfy this condition by pointing, via a
+        hypertext link, to the source of the "Information" and so supplying an actual
+        acknowledgement of its authorship.
+        
+        For example:
+        
+        "Ministry of xxx—Original data downloaded from
+        'http://www.data.gouv.fr/fr/datasets/xxx/', updated on 14 February 2017".
+        
+        This acknowledgement of authorship does not confer any official status on the
+        "Reuse" of the "Information", and must not suggest any sort of recognition or
+        endorsement on the part of the "Grantor", or any other public entity, of the
+        "Reuser" or of their "Reuse".
+        
+        
+        Personal data
+        
+        The "Information" made available may contain "Personal data" that may be
+        subject to "Reuse". If this is the case, the "Grantor" informs the "Reuser"
+        about its existence. The "Information" may be freely reused, within the rights
+        granted by this licence, subject to compliance with the legal framework
+        relating to personal data protection.
+        
+        
+        Intellectual property rights
+        
+        It is guaranteed to The "Reuser" that potential "Intellectual property rights"
+        held by third parties or by the "Grantor" on "Information" do not interfere
+        with the rights granted by this licence.
+        
+        When the "Grantor" holds transferable "Intellectual property rights" on the
+        "Information", he/she assigns these to the "Reuser" on a non-exclusive basis,
+        free of charge, worldwide, for the entire duration of the "Intellectual
+        property rights", and the "Reuser" is free to use the "Information" for any
+        purpose that complies with the rights and conditions defined in this licence.
+        
+        
+        Liability
+        
+        The "Information" is made available as it is produced or received by the
+        "Grantor", without any other express or tacit guarantee than those set out in
+        this licence. The "Grantor" does not guarantee the absence of errors or
+        inaccuracies in the "Information", nor a continuous supply of the
+        "Information". He/she cannot be held responsible for any loss, prejudice or
+        damage of any kind caused to third parties as a result of the "Reuse".
+        
+        The "Reuser" is solely responsible for the "Reuse" of the "Information". This
+        "Reuse" must not mislead third parties as to the contents of the "Information",
+        its source or its date of update.
+        
+        
+        Applicable legislation
+        
+        This licence is governed by French law.
+        
+        Compatibility of this licence
+        
+        This licence has been designed to be compatible with any free licence that at
+        least requires an acknowledgement of authorship, and specifically with the
+        previous version of this licence as well as with the following licences: United
+        Kingdom's "Open Government Licence" (OGL), Creative Commons' "Creative Commons
+        Attribution" (CC-BY) and Open Knowledge Foundation's "Open Data Commons
+        Attribution" (ODC-BY).
+        
+        
+        Definitions
+        
+        Within the meaning of this licence, are to be considered as:
+        
+        - The "Grantor": any person granting the right to "Reuse" "Information" under
+          the rights and conditions set out in this licence.
+        - The "Information":
+          - any public information contained in documents disclosed or published by any
+            administration referred to in the first paragraph of Article L. 300-2 of
+            the "Code des relations entre le public et l'administration (CRPA)",
+          - any information made available by any person under the terms and conditions
+            of this licence.
+        - The "Reuse": the use of the "Information" for other purposes than those for
+          which it was produced or received.
+        - The "Reuser": any person reusing the "Information" in accordance with the
+          conditions of this licence.
+        - "Personal data": any information relating to an identified or identifiable
+          natural person who may be identified directly or indirectly. Its "Reuse" is
+          conditional on the respect of the existing legal framework.
+        - "Derived information": any new data or information created directly from the
+          "Information" or from a combination of the "Information" and other data or
+          information not subject to this licence.
+        - "Intellectual property rights": all rights identified as such under the "Code
+          de la propriété intellectuelle" (including copyright, rights related to
+          copyright, sui generis rights of database producers, etc.).
+        
+        
+        About this licence
+        
+        This licence is intended to be used by administrations for the reuse of their
+        public information. It can also be used by any individual wishing to supply
+        "Information" under the conditions defined in this licence.
+        
+        France has a comprehensive legal framework aiming at the spontaneous
+        dissemination by the administrations of their public information in order to
+        ensure the widest possible reuse of this information.
+        
+        The right to "Reuse" the administrations' "Information" is governed by the
+        "Code des relations entre le public et l'administration (CRPA)".
+        
+        This licence facilitates the unrestricted and free of charge reuse of public
+        information and is one of the licences which can be used by the administration
+        pursuant to the decree issued under article L. 323-2 of the CRPA.
+        
+        Under the Prime Minister's authority, the Etalab mission is mandated to open up
+        the maximum amount of data held by State administrations and public
+        institutions. Etalab has drawn up the Open Licence to facilitate the
+        unrestricted and free of charge reuse of public information, as defined by
+        article L. 321-1 of the CRPA.
+        
+        This licence is version 2.0 of the Open Licence.
+        
+        Etalab reserves the right to propose new versions of the Open Licence.
+        Nevertheless, "Reusers" may continue to reuse information obtained under this
+        licence should they so wish.
+Project-URL: Homepage, https://gitlab.in2p3.fr/isdeform/stac-processor-gdmsar
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENCE.txt
+Requires-Dist: pystac-client
+Requires-Dist: pystac
+Requires-Dist: requests~=2.32.3
+Requires-Dist: typer~=0.15.1
+Requires-Dist: jinja2~=3.1.5
+Requires-Dist: pydantic
+Requires-Dist: geojson_pydantic
+Requires-Dist: shapely
+Requires-Dist: markdown-it-py
+Requires-Dist: mdit-py-plugins
+Requires-Dist: mdit-plain
+Requires-Dist: mdformat
+Requires-Dist: python-dateutil>=2.9.0.post0
+Requires-Dist: deepdiff>=8.4.2
+Dynamic: license-file
+
+# stac-processor-gdmsar
+
+<p align="center">
+  <img src="https://gdm.poleterresolide.fr/upload/services/service2_1.png" alt="GDM-SAR" style="vertical-align: middle; width: 100px; height: 100px;"/>
+  <img src="https://stacspec.org/public/images-original/STAC-01.png" style="vertical-align: middle; max-width: 400px; max-height: 100px;" />
+</p>
+
+A STAC [processor](https://github.com/fntb/stac-repository/) for [GDM-SAR](https://www.isdeform.fr/services-2/) products.
+
+## Overview
+
+We use [`uv`](https://docs.astral.sh/uv/getting-started/installation/) to manage the venv, dependencies, PYTHONPATH, etc. You (shouldn't but) can do without it, just create a `.venv`, activate it, install the dependencies, and add the repo to your $PYTHONPATH when running any of the scripts.
+
+Installing the dependencies from the `uv.lock` file
+
+```bash
+uv sync
+```
+
+## Usage
+
+As a standalone CLI :
+
+```bash
+uv run stac_processor_gdmsar/app.py --help
+```
+
+### Writing Component Templates
+
+See [here](./docs/writing-component-templates.md).
+
+Try them out with :
+
+```bash
+uv run scripts/render-template <template-id>
+```
+
+### Using `pystac-client` to Query the API
+
+See [the ISDeform data center public documentation](https://gitlab.in2p3.fr/fntb/isdeform-doc-public).
+
+### License
+
+[OPEN LICENCE 2.0](./LICENCE.txt)

stac_processor_gdmsar-0.0.2/README.md

@@ -0,0 +1,44 @@
+# stac-processor-gdmsar
+
+<p align="center">
+  <img src="https://gdm.poleterresolide.fr/upload/services/service2_1.png" alt="GDM-SAR" style="vertical-align: middle; width: 100px; height: 100px;"/>
+  <img src="https://stacspec.org/public/images-original/STAC-01.png" style="vertical-align: middle; max-width: 400px; max-height: 100px;" />
+</p>
+
+A STAC [processor](https://github.com/fntb/stac-repository/) for [GDM-SAR](https://www.isdeform.fr/services-2/) products.
+
+## Overview
+
+We use [`uv`](https://docs.astral.sh/uv/getting-started/installation/) to manage the venv, dependencies, PYTHONPATH, etc. You (shouldn't but) can do without it, just create a `.venv`, activate it, install the dependencies, and add the repo to your $PYTHONPATH when running any of the scripts.
+
+Installing the dependencies from the `uv.lock` file
+
+```bash
+uv sync
+```
+
+## Usage
+
+As a standalone CLI :
+
+```bash
+uv run stac_processor_gdmsar/app.py --help
+```
+
+### Writing Component Templates
+
+See [here](./docs/writing-component-templates.md).
+
+Try them out with :
+
+```bash
+uv run scripts/render-template <template-id>
+```
+
+### Using `pystac-client` to Query the API
+
+See [the ISDeform data center public documentation](https://gitlab.in2p3.fr/fntb/isdeform-doc-public).
+
+### License
+
+[OPEN LICENCE 2.0](./LICENCE.txt)

stac_processor_gdmsar-0.0.2/pyproject.toml

@@ -0,0 +1,66 @@
+[project]
+dynamic = ["version"]
+
+name = "stac-processor-gdmsar"
+description = "A stac-repository complient processor for GDM-SAR products"
+readme = "README.md"
+
+authors = [
+    { name = "Pierre Fontbonne", email = "pierre.fontbonne@uca.fr" },
+    { name = "Alexandre Burel", email = "alexandre.burel@cnrs.fr" }
+]
+maintainers = [{ name = "Alexandre Burel", email = "alexandre.burel@cnrs.fr" }]
+
+license.file = "LICENCE.txt"
+
+requires-python = ">=3.8"
+
+dependencies = [
+    "pystac-client",
+    "pystac",
+    "requests                ~= 2.32.3",
+    "typer                   ~= 0.15.1",
+    "jinja2                  ~= 3.1.5",
+    "pydantic",
+    "geojson_pydantic",
+    "shapely",
+    "markdown-it-py",
+    "mdit-py-plugins",
+    "mdit-plain",
+    "mdformat",
+    "python-dateutil>=2.9.0.post0",
+    "deepdiff>=8.4.2",
+]
+
+[project.urls]
+Homepage = "https://gitlab.in2p3.fr/isdeform/stac-processor-gdmsar"
+
+[dependency-groups]
+
+dev = [
+    "pytest>=8.3.5",
+]
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+packages = [
+    "stac_processor_gdmsar",
+    "stac_processor_gdmsar.processor",
+    "stac_processor_gdmsar.processor.explorer",
+    "stac_processor_gdmsar.templates",
+]
+
+[tool.setuptools.package-data]
+"*" = ["*.md"]
+
+[tool.setuptools.dynamic]
+version = { attr = "stac_processor_gdmsar.__about__.__version__" }
+
+[tool.pytest.ini_options]
+log_cli = true
+log_cli_level = "DEBUG"
+log_cli_format = "(%(filename)s:%(lineno)s) %(asctime)s [%(levelname)s] %(message)s"
+log_cli_date_format = "%H:%M:%S"

stac_processor_gdmsar-0.0.2/setup.cfg

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

stac_processor_gdmsar-0.0.2/stac_processor_gdmsar/__about__.py

@@ -0,0 +1,3 @@
+__version__ = "0.0.2"
+__catalog_name__ = "GDM-SAR-In"
+__catalog_desc__ = "Ground Deformation Monitoring using SAR Interferometry"

stac_processor_gdmsar-0.0.2/stac_processor_gdmsar/__init__.py

@@ -0,0 +1,11 @@
+import logging
+
+from stac_processor_gdmsar.__about__ import (
+    __version__,
+    __catalog_name__,
+    __catalog_desc__,
+)
+from stac_processor_gdmsar.discover import discover
+from stac_processor_gdmsar.id import id
+from stac_processor_gdmsar.version import version
+from stac_processor_gdmsar.process import process

stac_processor_gdmsar-0.0.2/stac_processor_gdmsar/app.py

@@ -0,0 +1,96 @@
+"""
+This file is a CLI to test the processor independently from a STAC Repository.
+To use it, just call "uv run stac_processor_gdmsar/app.py" from the main directory.
+
+The CLI has the following commands:
+- discover: to test the discover function, it will print the product sources discovered in the given source
+- process: to test the process function, it will convert the given product source into a STAC catalog, and save it in the given destination directory
+- version: to test the version function, it will print the version of the given product source
+- id: to test the id function, it will print the id of the given product source
+
+This CLI is only for testing purposes, it is not intended to be used by users of the processor, and it is not intended to be used in production. 
+It is only a way to test the processor independently from a STAC Repository, and to check that the output of the processor is correct.
+"""
+
+from typing import (
+    Optional
+)
+
+import typer
+import shutil
+import os
+from os import path
+
+from stac_processor_gdmsar.__about__ import __version__
+from stac_processor_gdmsar.discover import discover as api_discover
+from stac_processor_gdmsar.id import id as api_id
+from stac_processor_gdmsar.version import version as api_version
+from stac_processor_gdmsar.process import process as api_process
+from stac_processor_gdmsar.processor.fetch import fetch as api_fetch
+
+app = typer.Typer()
+
+@app.callback(invoke_without_command=True)
+def main(version: bool = False):
+    if version:
+        print(__version__)
+
+
+# commented because not tested
+# @app.command()
+# def fetch(product_source: str, dst: Optional[str] = None, only_metadata: bool = False):
+#     dst = api_fetch(product_source, dst, only_metadata=only_metadata)
+#     print(dst)
+
+
+@app.command()
+def discover(source: str):
+    # uv run stac_processor_gdmsar/app.py discover <source>
+    for product_source in api_discover(source):
+        print(product_source)
+
+
+@app.command()
+def version(product_source: str):
+    # uv run stac_processor_gdmsar/app.py version <product_source>
+    version = api_version(product_source)
+    print(version)
+
+
+@app.command()
+def id(product_source: str):
+    # uv run stac_processor_gdmsar/app.py id <product_source>
+    id = api_id(product_source)
+    print(id)
+
+
+@app.command()
+def process(product_source: str, destination: str):
+    # uv run stac_processor_gdmsar/app.py process <product_source> <destination>
+
+    # call the process function that returns the path of the corresponding collection in a temporary directory
+    result = api_process(product_source)
+    # the temporary directory
+    result_dir = path.dirname(result)
+
+    if destination is not None:
+        try:
+            # clean the previous content of destination, if any
+            shutil.rmtree(destination, ignore_errors=True)
+            os.makedirs(destination, exist_ok=True)
+
+            # move the content of the temporary directory to destination
+            for file_name in os.listdir(result_dir):
+                shutil.move(
+                    path.join(result_dir, file_name),
+                    path.join(destination, file_name)
+                )
+
+            result = path.join(destination, path.basename(result))
+            result_dir = path.dirname(result)
+
+        except BaseException as error:
+            raise error
+
+if __name__ == "__main__":
+    app()

stac_processor_gdmsar-0.0.2/stac_processor_gdmsar/discover.py

@@ -0,0 +1,52 @@
+from typing import Any, Iterator
+import re
+import logging
+
+from requests import HTTPError
+
+from stac_processor_gdmsar.processor import make_explorer, BaseExplorer
+
+logger = logging.getLogger(__file__)
+# Set the logging level for urllib3 to WARNING to reduce noise in the logs
+logging.getLogger("urllib3").setLevel(logging.WARNING)
+
+def _contains(dir, end_tag, explorer: BaseExplorer):
+    content = explorer.list_dir(dir)
+    for file in content:
+        if file.endswith(end_tag): return True
+    return False
+
+def _discover_product_sources(dir: str, explorer: BaseExplorer) -> Iterator[str]:
+    try:
+        if not explorer.is_directory(dir):
+            # dir is not a directory, skip it
+            return
+    except Exception as error:
+        logger.warning(f"Skipped directory {dir} : {str(error)}")
+        return
+
+    dir_name = explorer.basename(dir)
+
+    if re.search(r"^iw\d(?:_iw\d){0,2}/?$", dir_name):
+        # dir_name looks like iw1, iw1_iw2, iw1_iw2_iw3
+        if _contains(dir, ".json", explorer):
+            # returns the directory if there is at least one json file in it
+            yield dir
+        return
+
+    for file_name in explorer.list_dir(dir):
+        file = explorer.join(dir, file_name)
+        if re.search(r"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\/?$", file_name):
+            # recursively search for subdirectories that look like 123e4567-e89b-12d3-a456-426614174000
+            # search for json files within such subdirectories
+            yield from _discover_product_sources(file, explorer)
+        elif re.search(r"^iw\d(?:_iw\d){0,2}/?$", file_name):
+            # if a subdirectory looks like iw1, iw1_iw2, iw1_iw2_iw3
+            if _contains(file, ".json", explorer):
+                # returns the subdirectory if there is at least one json file in it
+                yield file
+
+
+def discover(source: str) -> Iterator[str]:
+    explorer = make_explorer(source)
+    yield from _discover_product_sources(source, explorer)

stac_processor_gdmsar-0.0.2/stac_processor_gdmsar/id.py

@@ -0,0 +1,7 @@
+from .processor import make_processor
+
+
+def id(product_source: str) -> str:
+    processor = make_processor(product_source)
+    
+    return processor.id