rss_da_stac 0.1.3__tar.gz

rss_da_stac-0.1.3/.gitignore

@@ -0,0 +1,163 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+public/*
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+*_version.py
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+docs_test/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv*
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+site/
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

rss_da_stac-0.1.3/.gitlab-ci.yml

@@ -0,0 +1,61 @@
+variables:
+  UV_VERSION: "0.8"
+  PYTHON_VERSION: "3.12"
+  BASE_LAYER: bookworm-slim
+  # GitLab CI creates a separate mountpoint for the build directory,
+  # so we need to copy instead of using hard links.
+  UV_LINK_MODE: copy
+
+stages:
+  - test
+  - build
+  - build_doc
+  - publish
+
+
+default:
+  before_script:
+    - apt-get update -y
+    - apt-get install -y git
+
+uv:
+  stage: test
+  image: ghcr.io/astral-sh/uv:$UV_VERSION-python$PYTHON_VERSION-$BASE_LAYER
+  script:
+    - uv run pytest
+
+build:
+  stage: build
+  image: ghcr.io/astral-sh/uv:$UV_VERSION-python$PYTHON_VERSION-$BASE_LAYER
+  script:
+    - uv build
+  artifacts:
+    paths:
+      - dist/
+
+
+pages:
+  stage: build_doc
+  image: ghcr.io/astral-sh/uv:$UV_VERSION-python$PYTHON_VERSION-$BASE_LAYER
+  script:
+    - uv run mkdocs build --no-strict --verbose 
+  artifacts:
+    paths:
+    - public
+  only:
+    - main
+
+
+publish:
+  stage: publish
+  image: ghcr.io/astral-sh/uv:$UV_VERSION-python$PYTHON_VERSION-$BASE_LAYER
+  id_tokens:
+    PYPI_ID_TOKEN:
+      aud: pypi
+  dependencies:
+    - build
+  script:
+    - uv publish dist/*.whl dist/*.tar.gz
+  rules:
+    - if: $CI_COMMIT_TAG
+

rss_da_stac-0.1.3/.pre-commit-config.yaml

@@ -0,0 +1,36 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.6.0
+  hooks:
+    - id: end-of-file-fixer
+    - id: check-added-large-files
+      args: ["--maxkb=600"]
+
+- repo: https://github.com/charliermarsh/ruff-pre-commit
+  rev: v0.9.5
+  hooks:
+    - id: ruff
+
+# for stuff not currently included in Ruff
+- repo: local
+  hooks:
+    - id: pylint
+      name: pylint
+      entry: uv run pylint
+      language: system
+      types: [python]
+      args:
+        [
+          "-rn", # Only display messages
+          "-sn", # Don't display the score
+          "--rcfile=pylintrc.toml", # Link to your config file
+          "--disable=too-many-positional-arguments"
+        ]
+
+- repo: https://github.com/astral-sh/uv-pre-commit
+  # uv version.
+  rev: 0.8.15
+  hooks:
+    - id: uv-lock

rss_da_stac-0.1.3/CHANGELOG.md

@@ -0,0 +1,29 @@
+# Changelog
+
+
+
+## Pre-release
+
+## 0.1.1 [2026-03-11]
+### Changed
+- relax the lower bound on typer so the package is easier to install with some other
+  packages (in particular, some versions of prefect pin typer to be < 0.16)
+
+### Added
+- A function to retrieve the version implemented, so you can now use `rss_da_stac.__version__`
+- `--version` now a callback hook in `rss-stac`
+
+### Fixed
+- Some STAC apis now require you to provide at least one collection when searching by item id. 
+  All the provider sentinel 2 collections are now searched for the id.
+
+## 0.1.0 [2026-01-05]
+### Changed
+- comparing geometry now done in pure python. Slightly slower than the shapely approach, but requires fewer packages, and numpy in particular is no longer needed. This should make it lighter and less problematic when using it in conjunction with `rss-da`.
+
+- sometimes there can be more than 2 items for a single qvf filename. In this case, we return the best match based on geometry, and in the case of ties, return the one with the most recent creation date. Warning is issued since this shouldn't generally happen, but might occur when
+querying old catalogues.
+
+## 0.0.1 [2025-12-11]
+
+Initial release.

rss_da_stac-0.1.3/LICENSE

@@ -0,0 +1,18 @@
+MIT No Attribution
+
+Copyright 2025 Robert Denham
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

rss_da_stac-0.1.3/PKG-INFO

@@ -0,0 +1,35 @@
+Metadata-Version: 2.4
+Name: rss_da_stac
+Version: 0.1.3
+Summary: Utilities for JRSRP users to interact with common STAC providers
+Author-email: rdenham <robert.denham@detsi.qld.gov.au>
+License-File: LICENSE
+Requires-Python: >=3.11
+Requires-Dist: planetary-computer>=1.0.0
+Requires-Dist: pystac-client<0.10.0
+Requires-Dist: pystac>=1.13.0
+Requires-Dist: pytz>=2025.2
+Requires-Dist: tifftools>=1.6.1
+Requires-Dist: typer>=0.15.0
+Description-Content-Type: text/markdown
+
+# `rss_da_stac` - Python utilities for interacting with common STAC providers
+
+Remote Sensing Scientists associated with the [JRSRP](https://www.jrsrp.org.au/)
+have several established work practices that have been developed over many years,
+and predate STAC and cloud-native Earth Observation (EO) data. 
+
+This package is designed To help integrate
+their current work approaches with modern data providers via STAC. Of particular
+interest is the interoperability of the [`qvf`](https://jrsrp.gitlab.io/sys/meta_info/)
+name convention and how that relates to STAC. Several utilities are designed
+to work with `qvf` style names, such as 
+
+* `qvf2item`: Convert one or more QVF files to a STAC ItemCollection
+* `item2qvf`: Given a stac item or itemcollection, provide the equivalent qvf compliant name for each item. 
+
+
+see [notes](docs/index.md) for details on the included scripts and the API.
+
+
+

rss_da_stac-0.1.3/README.md

@@ -0,0 +1,20 @@
+# `rss_da_stac` - Python utilities for interacting with common STAC providers
+
+Remote Sensing Scientists associated with the [JRSRP](https://www.jrsrp.org.au/)
+have several established work practices that have been developed over many years,
+and predate STAC and cloud-native Earth Observation (EO) data. 
+
+This package is designed To help integrate
+their current work approaches with modern data providers via STAC. Of particular
+interest is the interoperability of the [`qvf`](https://jrsrp.gitlab.io/sys/meta_info/)
+name convention and how that relates to STAC. Several utilities are designed
+to work with `qvf` style names, such as 
+
+* `qvf2item`: Convert one or more QVF files to a STAC ItemCollection
+* `item2qvf`: Given a stac item or itemcollection, provide the equivalent qvf compliant name for each item. 
+
+
+see [notes](docs/index.md) for details on the included scripts and the API.
+
+
+

rss_da_stac-0.1.3/docs/index.md

@@ -0,0 +1,218 @@
+# `rss_da_stac`: - Python utilities for interacting with STAC and Sentinel2
+
+
+
+## CLI
+
+Several commands are available:
+
+### `qvf2item`
+
+Designed so that if you have a qvf name, you can get an equivalent STAC Item, from one of the 
+main providers. For example
+
+```sh
+rss-stac qvf2item cfmsre_t56kkv_20221223_adbm6.tif
+```
+
+Default provider is element84.
+
+If there are multiple potential items, you will get multiple results, so you might want to 
+take care here. For example:
+
+```sh
+rss-stac qvf2item cfmsre_t53krt_20250705_ab0m3.img|jq '.features[].id'
+
+#"S2B_T53KRT_20250705T010237_L2A"
+#"S2B_T53KRT_20250705T010107_L2A"
+```
+
+The only reliable way I could work out to get a specific capture is to compare the
+geometry to a reference. For example, if you did a query on our in house database,
+you might get:
+
+```sh
+rss querydatabase --separator='\t' --raw --sql "select  ST_AsGeoJSON(geom) from sentinel2_list  where qvf_sa
+t = 'cf' and scene = 't53krt' and date='20250705'"
+```
+
+```json
+{"type":"Polygon","coordinates":[[[137.88287585319,-20.8637683840933],[137.864516174824,-19.872835815401],[138.911431015994,-19.8534526589396],[138.936450904658,-20.84276283712],[137.88287585319,-20.8637683840933]]]}
+```
+
+```sh
+rss-stac qvf2item cfmsre_t53krt_20250705_ab0m3.img \
+    --geom '{"type":"Polygon","coordinates":[[[137.88287585319,-20.8637683840933],[137.864516174824,-19.872835815401],[138.911431015994,-19.8534526589396],[138.936450904658,-20.84276283712],[137.88287585319,-20.8637683840933]]]}'
+```
+
+should return just the item with id `S2B_T53KRT_20250705T010237_L2A`.
+
+
+You can provide alterntive providers:
+
+```sh
+rss-stac qvf2item --provider CDSE cfmsre_t56kkv_20221223_adbm6.tif|jq '.features[].id'
+#"S2B_MSIL2A_20221223T001109_N0510_R073_T56KKV_20240803T180510"
+```
+
+For recent images, you'd expect the L1C option from CDSE to match ours:
+
+```sh
+rss-stac qvf2item cfmsre_t53krt_20250705_ab0m3.img --level l1c  --provider CDSE   --geom '{"type":"Polygon","c
+oordinates":[[[137.88287585319,-20.8637683840933],[137.864516174824,-19.872835815401],[138.911431015994,-19.8534526589396],[138.
+936450904658,-20.84276283712],[137.88287585319,-20.8637683840933]]]}'|jq '.features[].id'
+"S2B_MSIL1C_20250705T005709_N0511_R002_T53KRT_20250705T021954"
+```
+
+```sh
+rss querydatabase --separator='\t' --raw --sql "select  esa_id from sentinel2_list  where qvf_sat = 'cf' and scene = 't53krt' and date='20250705'"
+# S2B_MSIL1C_20250705T005709_N0511_R002_T53KRT_20250705T021954
+```
+
+
+
+
+
+It will also accept multiple input names:
+
+```sh
+rss-stac qvf2item cfmsre_t53krt_20250705_ab0m3.img cemsre_t50jll_20201227_abam0.json|jq -r '.features[].id'
+#S2B_T53KRT_20250705T010237_L2A
+#S2B_T53KRT_20250705T010107_L2A
+#S2A_T50JLL_20201227T021851_L2A
+```
+
+Or using a listfile:
+
+```sh
+cat <<EOF > listfile.txt
+cfmsre_t53krt_20250705_ab0m3.img
+cemsre_t50jll_20201227_abam0.json
+EOF
+
+rss-stac qvf2item --file listfile.txt |jq -r '.features[].id'
+
+
+
+Currently can use CDSE, planetary-ccomputer or element84.
+
+Default collection is S2L2A, but you can also get S2L1C
+
+```sh
+rss-stac qvf2item --level l1c --provider CDSE cfmsre_t56kkv_20221223_adbm6.tif|jq '.features[].id'
+#"S2B_MSIL1C_20221223T001109_N0510_R073_T56KKV_20240803T130258"
+```
+
+### `item2item`
+
+Convert an item from one provider to another.
+
+For example, if you have a CDSE item, and you'd like the equivalent from element84:
+
+```sh
+rss-stac qvf2item --level l1c --provider CDSE cfmsre_t56kkv_20221223_adbm6.tif| \
+    rss-stac item2item |jq '.features[].id'
+
+#"S2B_56KKV_20221223_0_L1C"
+```
+
+When there are potentially 2 items that match the same date, satellite, tile, we use
+the same geometry comparison as in the `qvf_to_stac` routine.
+
+
+
+
+### `item2qvf`
+
+Given an item, work out the qvf name
+
+```sh
+rss-stac qvf2item --level l1c --provider CDSE cfmsre_t56kkv_20221223_adbm6.tif| \
+    rss-stac item2qvf
+# should return the same name as you started
+# cfmsre_t56kkv_20221223_adbm6.tif
+```
+
+Same issue with multiple candidates:
+
+```sh
+rss-stac qvf2item cfmsre_t53krt_20250705_ab0m3.img|rss-stac  item2qvf
+
+# cfmsre_t53krt_20250705_adbm3.tif
+# cfmsre_t53krt_20250705_adbm3.tif
+```
+
+## `relevel`
+
+If you have a S2L1C and you'd like the S2L2A equivalent:
+
+```sh
+rss-stac qvf2item --level l1c --provider CDSE cfmsre_t56kkv_20221223_adbm6.tif|
+    rss-stac relevel |jq '.features[].id'
+
+# "S2B_MSIL2A_20221223T001109_N0510_R073_T56KKV_20240803T180510"
+```
+
+## `histitem`
+
+Some of our files have the STAC item embedded in the metadata. If you have a file
+like this, you can extract the item:
+
+```sh
+rss recall cfmsre_t56kkv_20221223_adbm6.tif
+rss-stac histitem cfmsre_t56kkv_20221223_adbm6.tif| jq '.id'
+
+# S2B_T56KKV_20221223T001108_L2A
+```
+
+Note that this command returns a single item. Other commands return an ItemCollection,
+even if the collection has a single item.
+
+
+## `cat`
+
+Sometimes you might want to concatenate items, collections. You can do this like
+
+```sh
+rss-stac qvf2item cfmsre_t53krt_20250705_ab0m3.img > item1.json
+rss-stac qvf2item cemsre_t50jll_20201227_abam0.json > item2.json
+
+rss-stac cat item1.json item2.json |jq -r '.features[].id'
+
+# S2B_T53KRT_20250705T010237_L2A
+# S2B_T53KRT_20250705T010107_L2A
+# S2A_T50JLL_20201227T021851_L2A
+```
+
+
+## Other miscellaneous commands
+
+I've also added a script that is a little bit specialised so I didn't put it in 
+with the other apps:
+
+```sh
+uri2l2a --help
+                                                                                                                                  
+ Usage: uri2l2a [OPTIONS] [URIS]...                                                                                               
+                                                                                                                                  
+ given s1c esa ids, convert to s2l2a and change provider to element84                                                             
+                                                                                                                                  
+```
+
+Basic idea is that it will take a product id, like 
+`S2B_MSIL1C_20250917T003659_N0511_R059_T54KZV_20250917T043259`
+and provide a STAC item from L2A element84.
+
+This is aimed at replacing the `qvf2stac`, since `qvfname` isn't
+always a 1:1 match to STAC items. This way should be.
+
+example:
+
+```sh
+uv run uri2l2a S2B_MSIL1C_20250917T003659_N0511_R059_T54KZV_20250917T043259|jq '.features[].id'
+#2B_T54KZV_20250917T004315_L2A
+
+uv run uri2l2a S2B_MSIL1C_20250917T003659_N0511_R059_T54KZV_20250917T043259 --provider cdse|jq '.features[].id'
+#S2B_MSIL2A_20250917T003659_N0511_R059_T54KZV_20250917T044524
+```
+

rss_da_stac-0.1.3/docs/reference.md

@@ -0,0 +1,7 @@
+This part of the project documentation focuses on
+an **information-oriented** approach. Use it as a
+reference for the technical implementation of the
+`src` project code.
+
+
+::: rss_da_stac

rss_da_stac-0.1.3/mkdocs.yml

@@ -0,0 +1,16 @@
+site_name: Remote Sensing Sciences - `rss_da_stac` for working with Sentinel 2 STAC 
+site_author: JRSRP
+site_url: https://jrsrp.gitlab.io/sys/stac/rss_da_stac/
+site_dir: public
+repo_url: https://jrsrp.gitlab.io/sys/stac/rss_da_stac/
+docs_dir: 'docs'
+
+theme:
+  name: "material"
+
+plugins:
+  - mkdocstrings
+
+nav:
+  - index.md
+  - reference.md