tilearray 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (96) hide show
  1. tilearray-0.1.0/.gitignore +183 -0
  2. tilearray-0.1.0/.pre-commit-config.yaml +24 -0
  3. tilearray-0.1.0/CHANGELOG.md +67 -0
  4. tilearray-0.1.0/CONTRIBUTING.md +31 -0
  5. tilearray-0.1.0/LICENSE +201 -0
  6. tilearray-0.1.0/Makefile +61 -0
  7. tilearray-0.1.0/PKG-INFO +345 -0
  8. tilearray-0.1.0/README.md +81 -0
  9. tilearray-0.1.0/docs/_static/.gitkeep +0 -0
  10. tilearray-0.1.0/docs/_static/guides/ea-lidar-elevation.json +35 -0
  11. tilearray-0.1.0/docs/_static/guides/ea-lidar-elevation.png +0 -0
  12. tilearray-0.1.0/docs/_static/guides/gibs-bluemarble.json +26 -0
  13. tilearray-0.1.0/docs/_static/guides/gibs-bluemarble.png +0 -0
  14. tilearray-0.1.0/docs/_static/guides/how-it-works-01-plan.png +0 -0
  15. tilearray-0.1.0/docs/_static/guides/how-it-works-02-fetch.png +0 -0
  16. tilearray-0.1.0/docs/_static/guides/how-it-works-03-decode.png +0 -0
  17. tilearray-0.1.0/docs/_static/guides/how-it-works-04-mosaic.png +0 -0
  18. tilearray-0.1.0/docs/_static/guides/how-it-works-05-lazy-compute-cache.png +0 -0
  19. tilearray-0.1.0/docs/_static/guides/how-it-works-06-downstream.png +0 -0
  20. tilearray-0.1.0/docs/_static/guides/how-it-works-pipeline.png +0 -0
  21. tilearray-0.1.0/docs/_static/guides/manifest.json +91 -0
  22. tilearray-0.1.0/docs/_static/guides/osm-london.json +25 -0
  23. tilearray-0.1.0/docs/_static/guides/osm-london.png +0 -0
  24. tilearray-0.1.0/docs/_static/logo/tilearray-mark-128.png +0 -0
  25. tilearray-0.1.0/docs/_static/logo/tilearray-mark-favicon-32.png +0 -0
  26. tilearray-0.1.0/docs/_static/logo/tilearray-mark-favicon.svg +14 -0
  27. tilearray-0.1.0/docs/_static/logo/tilearray-mark-on-dark.svg +17 -0
  28. tilearray-0.1.0/docs/_static/logo/tilearray-mark.svg +20 -0
  29. tilearray-0.1.0/docs/_templates/.gitkeep +0 -0
  30. tilearray-0.1.0/docs/api/index.md +107 -0
  31. tilearray-0.1.0/docs/building-docs.md +53 -0
  32. tilearray-0.1.0/docs/conf.py +82 -0
  33. tilearray-0.1.0/docs/example-sources.md +48 -0
  34. tilearray-0.1.0/docs/guides/ea-lidar.md +48 -0
  35. tilearray-0.1.0/docs/guides/gibs-bluemarble.md +41 -0
  36. tilearray-0.1.0/docs/guides/index.md +17 -0
  37. tilearray-0.1.0/docs/guides/osm-london.md +37 -0
  38. tilearray-0.1.0/docs/how-it-works.md +112 -0
  39. tilearray-0.1.0/docs/index.md +40 -0
  40. tilearray-0.1.0/docs/install.md +25 -0
  41. tilearray-0.1.0/docs/quickstart.md +103 -0
  42. tilearray-0.1.0/docs/troubleshooting.md +51 -0
  43. tilearray-0.1.0/example-sources.md +7 -0
  44. tilearray-0.1.0/guidelines.md +329 -0
  45. tilearray-0.1.0/pyproject.toml +249 -0
  46. tilearray-0.1.0/src/tilearray/__init__.py +89 -0
  47. tilearray-0.1.0/src/tilearray/_version.py +3 -0
  48. tilearray-0.1.0/src/tilearray/array.py +899 -0
  49. tilearray-0.1.0/src/tilearray/decode.py +353 -0
  50. tilearray-0.1.0/src/tilearray/errors.py +41 -0
  51. tilearray-0.1.0/src/tilearray/fetch.py +772 -0
  52. tilearray-0.1.0/src/tilearray/fetch_presets.py +77 -0
  53. tilearray-0.1.0/src/tilearray/pressure.py +129 -0
  54. tilearray-0.1.0/src/tilearray/py.typed +0 -0
  55. tilearray-0.1.0/src/tilearray/service/__init__.py +33 -0
  56. tilearray-0.1.0/src/tilearray/service/base.py +282 -0
  57. tilearray-0.1.0/src/tilearray/service/config.py +455 -0
  58. tilearray-0.1.0/src/tilearray/service/requests.py +70 -0
  59. tilearray-0.1.0/src/tilearray/service/wcs.py +657 -0
  60. tilearray-0.1.0/src/tilearray/service/wms.py +127 -0
  61. tilearray-0.1.0/src/tilearray/service/wmts.py +590 -0
  62. tilearray-0.1.0/src/tilearray/service/xyz.py +145 -0
  63. tilearray-0.1.0/src/tilearray/tiles.py +142 -0
  64. tilearray-0.1.0/src/tilearray/types.py +235 -0
  65. tilearray-0.1.0/tests/__init__.py +1 -0
  66. tilearray-0.1.0/tests/conftest.py +91 -0
  67. tilearray-0.1.0/tests/contract/README.md +62 -0
  68. tilearray-0.1.0/tests/contract/wcs/cassettes/TestEALidarWCSContract.test_describe_coverage.yaml +77 -0
  69. tilearray-0.1.0/tests/contract/wcs/cassettes/TestEALidarWCSContract.test_get_capabilities.yaml +70 -0
  70. tilearray-0.1.0/tests/contract/wcs/cassettes/TestEALidarWCSContract.test_get_coverage.yaml +412 -0
  71. tilearray-0.1.0/tests/contract/wcs/cassettes/TestUSGS3DEPWCSContract.test_describe_coverage_axis_labels.yaml +84 -0
  72. tilearray-0.1.0/tests/contract/wcs/cassettes/TestUSGS3DEPWCSContract.test_get_coverage_multipart_geotiff.yaml +112 -0
  73. tilearray-0.1.0/tests/contract/wcs/test_wcs_contract.py +179 -0
  74. tilearray-0.1.0/tests/data/ogc_schema_examples/lidar-composite-digital-terrain-model-dtm-1m.xml +154 -0
  75. tilearray-0.1.0/tests/data/wcs_fixtures/ea_lidar_describe_coverage.xml +17 -0
  76. tilearray-0.1.0/tests/data/wcs_fixtures/usgs_3dep_describe_coverage.xml +19 -0
  77. tilearray-0.1.0/tests/data/wcs_tiles/ea_lidar_64x64.tif +0 -0
  78. tilearray-0.1.0/tests/integration/test_live_endpoints.py +107 -0
  79. tilearray-0.1.0/tests/unit/test_array.py +1125 -0
  80. tilearray-0.1.0/tests/unit/test_compute_with_policy.py +199 -0
  81. tilearray-0.1.0/tests/unit/test_decode.py +189 -0
  82. tilearray-0.1.0/tests/unit/test_errors.py +36 -0
  83. tilearray-0.1.0/tests/unit/test_fetch.py +822 -0
  84. tilearray-0.1.0/tests/unit/test_fetch_abort_array.py +94 -0
  85. tilearray-0.1.0/tests/unit/test_fetch_bench.py +34 -0
  86. tilearray-0.1.0/tests/unit/test_fetch_presets.py +85 -0
  87. tilearray-0.1.0/tests/unit/test_pressure.py +129 -0
  88. tilearray-0.1.0/tests/unit/test_service_registry.py +63 -0
  89. tilearray-0.1.0/tests/unit/test_service_requests.py +118 -0
  90. tilearray-0.1.0/tests/unit/test_tiles.py +238 -0
  91. tilearray-0.1.0/tests/unit/test_types.py +79 -0
  92. tilearray-0.1.0/tests/unit/test_wcs_service.py +318 -0
  93. tilearray-0.1.0/tests/unit/test_wms_service.py +191 -0
  94. tilearray-0.1.0/tests/unit/test_wmts_service.py +293 -0
  95. tilearray-0.1.0/tests/unit/test_xyz_service.py +292 -0
  96. tilearray-0.1.0/tox.ini +27 -0
@@ -0,0 +1,183 @@
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[cod]
4
+ *$py.class
5
+
6
+ # C extensions
7
+ *.so
8
+
9
+ # Distribution / packaging
10
+ .Python
11
+ build/
12
+ develop-eggs/
13
+ dist/
14
+ downloads/
15
+ eggs/
16
+ .eggs/
17
+ lib/
18
+ lib64/
19
+ parts/
20
+ sdist/
21
+ var/
22
+ wheels/
23
+ share/python-wheels/
24
+ *.egg-info/
25
+ .installed.cfg
26
+ *.egg
27
+ MANIFEST
28
+
29
+ # PyInstaller
30
+ # Usually these files are written by a python script from a template
31
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
32
+ *.manifest
33
+ *.spec
34
+
35
+ # Installer logs
36
+ pip-log.txt
37
+ pip-delete-this-directory.txt
38
+
39
+ # Unit test / coverage reports
40
+ htmlcov/
41
+ .tox/
42
+ .nox/
43
+ .coverage
44
+ .coverage.*
45
+ .cache
46
+ nosetests.xml
47
+ coverage.xml
48
+ *.cover
49
+ *.py,cover
50
+ .hypothesis/
51
+ .pytest_cache/
52
+ cover/
53
+
54
+ # Translations
55
+ *.mo
56
+ *.pot
57
+
58
+ # Django stuff:
59
+ *.log
60
+ local_settings.py
61
+ db.sqlite3
62
+ db.sqlite3-journal
63
+
64
+ # Flask stuff:
65
+ instance/
66
+ .webassets-cache
67
+
68
+ # Scrapy stuff:
69
+ .scrapy
70
+
71
+ # Sphinx documentation
72
+ docs/_build/
73
+
74
+ # PyBuilder
75
+ .pybuilder/
76
+ target/
77
+
78
+ # Jupyter Notebook
79
+ .ipynb_checkpoints
80
+ *.ipynb_checkpoints
81
+
82
+ # Large data files in notebooks
83
+ notebooks/data/
84
+ notebooks/outputs/
85
+ notebooks/*.csv
86
+ notebooks/*.json
87
+ notebooks/*.pkl
88
+
89
+ # IPython
90
+ profile_default/
91
+ ipython_config.py
92
+
93
+ # pyenv
94
+ # For a library or package, you might want to ignore these files since the code is
95
+ # intended to run in multiple environments; otherwise, check them in:
96
+ # .python-version
97
+
98
+ # pipenv
99
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
100
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
101
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
102
+ # install all needed dependencies.
103
+ #Pipfile.lock
104
+
105
+ # poetry
106
+ # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
107
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
108
+ # commonly ignored for libraries.
109
+ # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
110
+ #poetry.lock
111
+
112
+ # pdm
113
+ # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
114
+ #pdm.lock
115
+ # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
116
+ # in version control.
117
+ # https://pdm.fming.dev/#use-with-ide
118
+ .pdm.toml
119
+
120
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
121
+ __pypackages__/
122
+
123
+ # Celery stuff
124
+ celerybeat-schedule
125
+ celerybeat.pid
126
+
127
+ # SageMath parsed files
128
+ *.sage.py
129
+
130
+ # Environments
131
+ .env
132
+ .venv
133
+ env/
134
+ venv/
135
+ ENV/
136
+ env.bak/
137
+ venv.bak/
138
+
139
+ # Spyder project settings
140
+ .spyderproject
141
+ .spyproject
142
+
143
+ # Rope project settings
144
+ .ropeproject
145
+
146
+ # mkdocs documentation
147
+ /site
148
+
149
+ # mypy
150
+ .mypy_cache/
151
+ .dmypy.json
152
+ dmypy.json
153
+
154
+ # Pyre type checker
155
+ .pyre/
156
+
157
+ # pytype static type analyzer
158
+ .pytype/
159
+
160
+ # Cython debug symbols
161
+ cython_debug/
162
+
163
+ # PyCharm
164
+ # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
165
+ # be added to the global gitignore or merged into this project gitignore. For a PyCharm
166
+ # project, it is recommended to include the following files:
167
+ # .idea/
168
+ # *.iml
169
+ # *.ipr
170
+ # *.iws
171
+ .idea/
172
+
173
+ # VS Code
174
+ .vscode/
175
+
176
+ # uv
177
+ .uv/
178
+
179
+ # Local artifacts and tool caches
180
+ artifacts/
181
+ .ruff_cache/
182
+ # Sphinx autosummary
183
+ docs/api/generated/
@@ -0,0 +1,24 @@
1
+ repos:
2
+ - repo: https://github.com/pre-commit/pre-commit-hooks
3
+ rev: v4.4.0
4
+ hooks:
5
+ - id: trailing-whitespace
6
+ - id: end-of-file-fixer
7
+ - id: check-yaml
8
+ - id: check-added-large-files
9
+ - id: check-merge-conflict
10
+ - id: debug-statements
11
+
12
+ - repo: https://github.com/astral-sh/ruff-pre-commit
13
+ rev: v0.14.2
14
+ hooks:
15
+ - id: ruff
16
+ args: [--fix]
17
+ - id: ruff-format
18
+
19
+ - repo: https://github.com/pre-commit/mirrors-mypy
20
+ rev: v1.18.2
21
+ hooks:
22
+ - id: mypy
23
+ files: ^src/tilearray/
24
+ additional_dependencies: []
@@ -0,0 +1,67 @@
1
+ # Changelog
2
+
3
+ All notable changes to this project will be documented in this file.
4
+
5
+ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6
+ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
+
8
+ ## [Unreleased]
9
+
10
+ ## [0.1.0] - 2026-10-31
11
+
12
+ Initial alpha release focused on lazy WCS- and XYZ-backed xarray arrays.
13
+
14
+ ### Fixed
15
+
16
+ - **Shared pressure pipeline:** HTTP responses are classified (status + body signatures) before retry / AIMD / circuit-breaker handling — replaces host-shaped forks (EA 403-only breaker, USGS-only OGC 404 helpers). Built-in signatures cover gateway 403/408/429/5xx and OGC `ExceptionReport` / `InvalidParameterValue` / `SUBSETTINGCRS` transient 404 bodies; custom signatures are pluggable via `PressureClassifier.register`
17
+ - Disk tile cache + decode: trust bytes over `Content-Type` — `sniff_effective_content_type` detects multipart / TIFF markers; `.meta` sidecar is kept but warm reads no longer require perfect headers
18
+
19
+ ### Added
20
+
21
+ - `tilearray.pressure`: `PressureSignature`, `PressureClassifier`, `classify_response`, and built-in signature registry
22
+ - EA DSP fetch preset: **pressure circuit breaker** (6+ classified breaker events within 5 s — gateway 403 or 429 — → freeze AIMD at floor for 15 s) to limit WAF/retry storms on large cold mosaics
23
+ - `TileFetcher.stats`: live `current_limit`, `pressure_event_count`, `circuit_breaker_trips`, and `circuit_breaker_frozen` for observing AIMD backoff during gateway pressure
24
+ - Mosaic fetch **abort**: after a hard tile failure (`NetworkError`), sibling tile tasks stop scheduling new HTTP (via shared `FetchProgress`); in-flight requests may still complete (Dask thread pool limitation)
25
+
26
+ - Capabilities-driven WCS GetCoverage: axis labels and native CRS from DescribeCoverage; automatic reprojection to native CRS when needed; shared `unwrap_multipart` for ArcGIS `multipart/related` GeoTIFF payloads
27
+ - Offline USGS 3DEP ArcGIS WCS contract tests (DescribeCoverage + multipart GetCoverage cassettes)
28
+ - Thin WMS 1.3.0 and WMTS 1.0.0 adapters: `WMSService` (GetMap with CRS-aware bbox), `WMTSService` (GetTile REST or KVP, optional GetCapabilities), `WMSConfig` / `WMTSConfig`, shared decode and request composition with WCS/XYZ (no host-specific presets)
29
+ - `TileFetcher` engine: shared `httpx` client, bounded concurrency, `tenacity` retries (429/5xx, `Retry-After`), and pluggable per-host rate limiting via `ServiceConfig`
30
+ - Retryable HTTP status codes now include gateway throttling **403** and **408** (same AIMD / `Retry-After` path as 429/503)
31
+ - Fetch presets: `XYZConfig.for_openstreetmap()` (OSMF User-Agent + polite limits) and `WCSConfig.for_ea_dsp()` (EA WCS Retry-After / 429 tuning)
32
+ - Offline before/after bench script: `scripts/bench_fetch_engine.py` (results in `benchmarks/fetch_engine_bench_results.txt`)
33
+ - Optional `on_progress(done, total, request, response)` callback on `create_array` / `load_array`
34
+ - WCS 2.0.1 coverage loading via `create_array` / `load_array` and `WCSService`
35
+ - XYZ / slippy-map tile support via `XYZConfig` and `XYZService`
36
+ - Service registry (`get_service`, `register_service`, `detect_service_type`)
37
+ - `create_tile_grid` helper for origin-aligned gridded tile planning
38
+ - Offline WCS contract tests with VCR cassettes (EA Lidar DTM)
39
+
40
+ ### Changed
41
+
42
+ - EA DSP preset AIMD ceiling lowered from 32 to **10** (live county-scale evidence: ceiling 32 fails on ≥~256-tile cold mosaics; ceiling 8 completes Aire ~1015-tile valley)
43
+ - README / example-sources: county-scale EA guidance (`max_concurrent_requests` ≤ preset ceiling)
44
+ - README: shared client AIMD gate, mosaic queue vs concurrency, EA sustained ceiling (~10)
45
+
46
+ - WCS subset axes no longer hard-code Long/Lat per CRS; `WCSService` reads envelope `axisLabels` from DescribeCoverage (EA `E`/`N`, ArcGIS `x`/`y`, geographic fallback `Long`/`Lat`)
47
+ - README: capabilities-driven WCS, shared `multipart/related` GeoTIFF unwrap, and EA Lidar + USGS 3DEP proof on real endpoints
48
+ - `create_array` / `load_array`: y coordinates now decrease with row index (north at row 0), matching `_organize_tiles` mosaic layout so north-up display no longer requires a manual flip
49
+ - Multi-band mosaic assembly: spatial `concatenate` on `y`/`x` for RGB JPEG/PNG tiles (fixes `da.block` stacking along `band`); single-band GeoTIFF mosaics still use `da.block`
50
+ - README: `create_array` output has north-up y coordinates (row 0 = north)
51
+ - README: north-star positioning (GIS/ML objective, shared request-and-decode base, adaptive AIMD under a ceiling, presets for host quirks only)
52
+ - example-sources: peer quirk one-liners for GIBS BlueMarble (layer-specific WMTS/XYZ template), EA VOM WMS (year-suffixed layers, transparent PNG RGBA)
53
+ - README and example-sources: document shared decode pipeline (JPEG/PNG `preserve`, GeoTIFF `first_band`) and request composition (`compose_tile_request` wires config headers/params)
54
+ - README and example-sources: less-jumpy AIMD 256-tile bench note (×0.75, floor 4); peer stress source shortlist
55
+ - README Fetch presets: retries / gateway pressure note (403/408, AIMD pressure, fail-loud mosaics)
56
+ - `load_array` / `create_array` raise `NetworkError` when a tile fetch fails after retries instead of silently filling failed regions with NaN
57
+ - README Fetch presets: live 64-tile (~5 km) bench (~20 s at ceiling 16 / `max_inflight` 8 → ~14.7 s at ceiling 32 with aligned Dask workers); `compute_thread_pool_size` noted in Public API table
58
+ - README Fetch presets: honest Skipton warm-start timings and note that EA ceiling 32 is a tunable safety max
59
+ - README and example-sources: fetch preset docs updated for AIMD EA DSP defaults (adaptive concurrency, no fixed 1 req/s cap)
60
+ - README and example-sources: fetch preset quick start, Fetch presets section, and corrected EA Lidar CoverageId in examples
61
+ - Tile HTTP moved from per-call `requests.get` to centralised `TileFetcher` (`httpx` + semaphore); `fetch_tile` delegates to the shared fetcher
62
+ - `respx` moved from runtime to dev dependencies
63
+ - Package renamed from scaffold `ogc-array` to `tilearray`; README, CI, and metadata aligned with shipped API
64
+ - EA Lidar WCS GeoTIFF decode and non-divisible tile resize for native-resolution tiles
65
+
66
+ [Unreleased]: https://github.com/MatthewJWhittle/tilearray/compare/v0.1.0...HEAD
67
+ [0.1.0]: https://github.com/MatthewJWhittle/tilearray/releases/tag/v0.1.0
@@ -0,0 +1,31 @@
1
+ # Contributing
2
+
3
+ Thanks for helping with tilearray.
4
+
5
+ ## Setup
6
+
7
+ ```bash
8
+ git clone https://github.com/MatthewJWhittle/tilearray.git
9
+ cd tilearray
10
+ uv sync --dev
11
+ make pre-commit
12
+ ```
13
+
14
+ ## Checks
15
+
16
+ ```bash
17
+ make test
18
+ make lint
19
+ make docs # HTML under docs/_build/html/
20
+ make docs-artifacts # regenerate committed figures (network for live guides)
21
+ ```
22
+
23
+ ## Pull requests
24
+
25
+ 1. Branch from `main`.
26
+ 2. Keep changes focused; run `make test && make lint` before opening a PR.
27
+ 3. Docs-only work: see [Building the docs](docs/building-docs.md).
28
+
29
+ ## Project conventions
30
+
31
+ Contributor and agent policy (layout, tests, packaging) lives in [guidelines.md](guidelines.md). That file is for people changing the repo — not product documentation for library users.
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,61 @@
1
+ .PHONY: help install install-dev test test-cov lint format clean build publish docs docs-artifacts docs-clean
2
+
3
+ help: ## Show this help message
4
+ @echo 'Usage: make [target]'
5
+ @echo ''
6
+ @echo 'Targets:'
7
+ @awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {printf " %-15s %s\n", $$1, $$2}' $(MAKEFILE_LIST)
8
+
9
+ install: ## Install the package
10
+ uv sync
11
+
12
+ install-dev: ## Install the package in development mode
13
+ uv sync --dev
14
+
15
+ test: ## Run tests
16
+ uv run pytest
17
+
18
+ test-cov: ## Run tests with coverage
19
+ uv run pytest --cov=src/tilearray --cov-report=html --cov-report=term-missing
20
+
21
+ lint: ## Run linting
22
+ uv run ruff format --check src tests
23
+ uv run ruff check src tests
24
+ uv run mypy src/tilearray
25
+
26
+ format: ## Format code
27
+ uv run ruff format src tests
28
+ uv run ruff check --fix src tests
29
+
30
+ clean: ## Clean build artifacts
31
+ rm -rf build/
32
+ rm -rf dist/
33
+ rm -rf *.egg-info/
34
+ rm -rf .coverage
35
+ rm -rf htmlcov/
36
+ rm -rf .pytest_cache/
37
+ rm -rf .mypy_cache/
38
+
39
+ build: ## Build the package
40
+ uv build
41
+
42
+ docs: ## Build Sphinx HTML docs (offline; no tile fetches)
43
+ uv sync --extra docs --dev
44
+ uv run --extra docs sphinx-build -W -b html docs docs/_build/html
45
+
46
+ docs-artifacts: ## Regenerate all committed docs assets (diagrams + live guide figures)
47
+ uv sync --extra docs --dev
48
+ uv run --extra docs python scripts/generate_how_it_works_figures.py
49
+ uv run --extra docs python scripts/generate_docs_artifacts.py
50
+
51
+ docs-clean: ## Remove Sphinx build output
52
+ rm -rf docs/_build docs/api/generated
53
+
54
+ publish: ## Publish to PyPI (UV_PUBLISH_TOKEN or trusted publishing)
55
+ uv publish
56
+
57
+ pre-commit: ## Install pre-commit hooks
58
+ uv run pre-commit install
59
+
60
+ pre-commit-run: ## Run pre-commit on all files
61
+ uv run pre-commit run --all-files