concavewrap-geo 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.
@@ -0,0 +1,9 @@
1
+ # Changelog
2
+
3
+ ## 0.1.0 — 2026-10-01
4
+
5
+ - Add polygon-safe concave hull construction with explicit ratio semantics.
6
+ - Add global, grouped, and disconnected-component scopes.
7
+ - Add hole, invalid-geometry, and convex-fallback policies.
8
+ - Add GeoPackage output, JSON diagnostics, CLI, Python API, and synthetic tests.
9
+ - Add executable forest-patch, large-gap, narrow-neck, and hole-policy examples.
@@ -0,0 +1,8 @@
1
+ cff-version: 1.2.0
2
+ message: "If you use concavewrap-geo, please cite this software."
3
+ title: "concavewrap-geo"
4
+ version: 0.1.0
5
+ authors:
6
+ - family-names: Nikitina
7
+ given-names: Alena
8
+ license: Apache-2.0
@@ -0,0 +1,5 @@
1
+ # Contributing
2
+
3
+ Please open an issue before a large change. Geometry behavior must include tests
4
+ for coverage, validity, convex bounds, and deterministic grouping. Use synthetic
5
+ or openly licensed data only.
@@ -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,3 @@
1
+ include CHANGELOG.md CITATION.cff CONTRIBUTING.md SECURITY.md
2
+ recursive-include docs *.md *.svg
3
+ recursive-include examples *.py
@@ -0,0 +1,185 @@
1
+ Metadata-Version: 2.4
2
+ Name: concavewrap-geo
3
+ Version: 0.1.0
4
+ Summary: Auditable concave hulls that cover complete polygon areas
5
+ Author: Alena Nikitina
6
+ License-Expression: Apache-2.0
7
+ Project-URL: Homepage, https://github.com/NikitinaAD/concavewrap-geo
8
+ Project-URL: Repository, https://github.com/NikitinaAD/concavewrap-geo
9
+ Project-URL: Issues, https://github.com/NikitinaAD/concavewrap-geo/issues
10
+ Keywords: gis,geospatial,polygon,concave-hull,shapely
11
+ Classifier: Development Status :: 3 - Alpha
12
+ Classifier: Intended Audience :: Science/Research
13
+ Classifier: Programming Language :: Python :: 3
14
+ Classifier: Programming Language :: Python :: 3.11
15
+ Classifier: Programming Language :: Python :: 3.12
16
+ Classifier: Programming Language :: Python :: 3.13
17
+ Classifier: Topic :: Scientific/Engineering :: GIS
18
+ Requires-Python: >=3.11
19
+ Description-Content-Type: text/markdown
20
+ License-File: LICENSE
21
+ Requires-Dist: geopandas>=0.14
22
+ Requires-Dist: shapely<3,>=2.0
23
+ Requires-Dist: pyproj>=3.6
24
+ Provides-Extra: test
25
+ Requires-Dist: pytest>=8; extra == "test"
26
+ Requires-Dist: pytest-cov>=5; extra == "test"
27
+ Requires-Dist: ruff>=0.8; extra == "test"
28
+ Dynamic: license-file
29
+
30
+ # concavewrap-geo
31
+
32
+ [![CI](https://github.com/NikitinaAD/concavewrap-geo/actions/workflows/ci.yml/badge.svg)](https://github.com/NikitinaAD/concavewrap-geo/actions/workflows/ci.yml)
33
+ [![PyPI](https://img.shields.io/pypi/v/concavewrap-geo.svg)](https://pypi.org/project/concavewrap-geo/)
34
+ [![Python](https://img.shields.io/pypi/pyversions/concavewrap-geo.svg)](https://pypi.org/project/concavewrap-geo/)
35
+ [![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
36
+
37
+ **Build auditable concave hulls that cover complete polygon areas.**
38
+
39
+ Many concave-hull implementations guarantee that the output contains the input
40
+ vertices. For areal data that is not enough: a hull edge can cut through a source
41
+ polygon. `concavewrap` repairs or rejects invalid input, constructs the hull, and
42
+ then enforces and verifies coverage of every source polygon.
43
+
44
+ ![Polygon patches become a polygon-safe concave hull](https://raw.githubusercontent.com/NikitinaAD/concavewrap-geo/main/docs/demo.svg)
45
+
46
+ ## Quick start
47
+
48
+ ```bash
49
+ python -m pip install concavewrap-geo
50
+ concavewrap build areas.gpkg \
51
+ --layer areas \
52
+ --ratio 0.25 \
53
+ --output hulls.gpkg \
54
+ --diagnostics hulls.json
55
+ ```
56
+
57
+ The output is a GeoPackage layer named `hulls`. The JSON report records input and
58
+ output areas, added fill area, the convex-hull area, coverage checks, repaired
59
+ features, and any convex fallback.
60
+
61
+ ## Reproducible example
62
+
63
+ Generate and process four synthetic polygon arrangements, including the failure
64
+ modes that commonly make a single concave-hull setting misleading:
65
+
66
+ ```bash
67
+ python examples/run_examples.py
68
+ ```
69
+
70
+ | scenario | question answered | expected result |
71
+ |---|---|---|
72
+ | `forest-patches` | can irregular areal patches be wrapped without cutting them? | one hull that covers every complete polygon |
73
+ | `large-gap` | should disconnected patches be bridged? | `global` gives one hull; `component` gives two |
74
+ | `narrow-neck` | does a thin connecting polygon remain covered? | one valid hull covering the neck and both ends |
75
+ | `ring-with-hole` | should a semantic hole remain open? | `allow_holes=True` keeps it; the default fills it |
76
+
77
+ Generated inputs, outputs, and JSON reports are placed under
78
+ `examples/generated/`. To run the standard case through the CLI:
79
+
80
+ ```bash
81
+ concavewrap build examples/generated/forest-patches.gpkg \
82
+ --layer areas \
83
+ --ratio 0.25 \
84
+ --output examples/generated/forest-hull-cli.gpkg \
85
+ --diagnostics examples/generated/forest-hull-cli.json
86
+ ```
87
+
88
+ Expected audit values are printed and asserted by the script, then saved in
89
+ `summary.json`. No external or real-world data is used.
90
+
91
+ ## Ratio and policies
92
+
93
+ `--ratio` follows GEOS/Shapely semantics:
94
+
95
+ | value | behavior |
96
+ |---:|---|
97
+ | `0` | most concave result available from the input vertices |
98
+ | `0.25` | useful starting point for irregular polygon collections |
99
+ | `1` | convex hull |
100
+
101
+ The ratio is dimensionless. It is not an alpha radius or a distance threshold,
102
+ so values from alpha-shape tools cannot be copied directly.
103
+
104
+ | option | choices | meaning |
105
+ |---|---|---|
106
+ | `--scope` | `global`, `component` | bridge all polygons in a group, or keep disconnected dissolved components separate |
107
+ | `--group-by FIELD` | any scalar field | build an independent result for each attribute value |
108
+ | `--allow-holes` | flag | retain source holes and permit hull holes; without it all holes are filled |
109
+ | `--invalid` | `repair`, `error` | repair invalid polygonal geometry with GEOS or stop |
110
+ | `--fallback` | `convex`, `error` | use and report the convex hull if the concave operation fails, or stop |
111
+
112
+ ## Guarantees
113
+
114
+ For every output record, `concavewrap` verifies that:
115
+
116
+ - the result is valid polygonal geometry;
117
+ - the result covers the complete input polygon area, not only its vertices;
118
+ - the result does not extend beyond the convex hull, within floating-point tolerance;
119
+ - the chosen hole, grouping, component, repair, and fallback policies are recorded;
120
+ - input ordering determines stable group and component ordering.
121
+
122
+ ## Output fields
123
+
124
+ | field | meaning |
125
+ |---|---|
126
+ | `hull_id` | stable one-based output identifier |
127
+ | `group_value` | text representation of the grouping value, or null |
128
+ | `source_features` | number of input features contributing to the hull |
129
+ | `repaired_features` | number of invalid contributors repaired |
130
+ | `input_area` | dissolved source area in CRS square units |
131
+ | `hull_area` | output hull area |
132
+ | `fill_area` | area added around or between source polygons |
133
+ | `convex_area` | area of the corresponding convex hull |
134
+ | `hull_to_convex_ratio` | output area divided by convex-hull area |
135
+ | `fallback_used` | whether the convex fallback was used |
136
+ | `fallback_reason` | captured failure message, if any |
137
+ | `ratio`, `allow_holes`, `scope` | effective construction settings |
138
+ | `covers_input` | final invariant check |
139
+
140
+ ## Python API
141
+
142
+ ```python
143
+ import geopandas as gpd
144
+ from concavewrap import HullOptions, HullResult, build_hulls
145
+
146
+ areas = gpd.read_file("areas.gpkg", layer="areas")
147
+ result: HullResult = build_hulls(
148
+ areas,
149
+ HullOptions(ratio=0.25, scope="global", allow_holes=False),
150
+ )
151
+ result.hulls.to_file("hulls.gpkg", layer="hulls", driver="GPKG")
152
+ print(result.report())
153
+ ```
154
+
155
+ The stable public interface is `build_hulls(...)`, `HullOptions`, `HullResult`,
156
+ and `HullDiagnostic`.
157
+
158
+ ## Limits
159
+
160
+ - Input geometries must be Polygon or MultiPolygon.
161
+ - A projected CRS with horizontal units in metres is required so that area audit
162
+ values are meaningful and comparable.
163
+ - `component` scope dissolves touching and overlapping polygons before identifying
164
+ disconnected components.
165
+ - Concave hulls are not unique across algorithms. This package uses the GEOS
166
+ algorithm exposed by Shapely and records its ratio explicitly.
167
+ - A hull is a generalization. Always inspect results for sparse samples, narrow
168
+ necks, very large gaps, and geometries whose holes have semantic meaning.
169
+
170
+ Run `concavewrap --help` for all options. Exit code `0` means success and `2`
171
+ means invalid input or a processing failure.
172
+
173
+ The pre-release and launch checks are listed in
174
+ [`docs/release-checklist.md`](docs/release-checklist.md).
175
+
176
+ ## Development
177
+
178
+ ```bash
179
+ python -m pip install -e ".[test]"
180
+ python -m ruff check .
181
+ python -m ruff format --check .
182
+ python -m pytest
183
+ ```
184
+
185
+ Copyright 2026 Alena Nikitina. Licensed under the [Apache License 2.0](LICENSE).
@@ -0,0 +1,156 @@
1
+ # concavewrap-geo
2
+
3
+ [![CI](https://github.com/NikitinaAD/concavewrap-geo/actions/workflows/ci.yml/badge.svg)](https://github.com/NikitinaAD/concavewrap-geo/actions/workflows/ci.yml)
4
+ [![PyPI](https://img.shields.io/pypi/v/concavewrap-geo.svg)](https://pypi.org/project/concavewrap-geo/)
5
+ [![Python](https://img.shields.io/pypi/pyversions/concavewrap-geo.svg)](https://pypi.org/project/concavewrap-geo/)
6
+ [![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
7
+
8
+ **Build auditable concave hulls that cover complete polygon areas.**
9
+
10
+ Many concave-hull implementations guarantee that the output contains the input
11
+ vertices. For areal data that is not enough: a hull edge can cut through a source
12
+ polygon. `concavewrap` repairs or rejects invalid input, constructs the hull, and
13
+ then enforces and verifies coverage of every source polygon.
14
+
15
+ ![Polygon patches become a polygon-safe concave hull](https://raw.githubusercontent.com/NikitinaAD/concavewrap-geo/main/docs/demo.svg)
16
+
17
+ ## Quick start
18
+
19
+ ```bash
20
+ python -m pip install concavewrap-geo
21
+ concavewrap build areas.gpkg \
22
+ --layer areas \
23
+ --ratio 0.25 \
24
+ --output hulls.gpkg \
25
+ --diagnostics hulls.json
26
+ ```
27
+
28
+ The output is a GeoPackage layer named `hulls`. The JSON report records input and
29
+ output areas, added fill area, the convex-hull area, coverage checks, repaired
30
+ features, and any convex fallback.
31
+
32
+ ## Reproducible example
33
+
34
+ Generate and process four synthetic polygon arrangements, including the failure
35
+ modes that commonly make a single concave-hull setting misleading:
36
+
37
+ ```bash
38
+ python examples/run_examples.py
39
+ ```
40
+
41
+ | scenario | question answered | expected result |
42
+ |---|---|---|
43
+ | `forest-patches` | can irregular areal patches be wrapped without cutting them? | one hull that covers every complete polygon |
44
+ | `large-gap` | should disconnected patches be bridged? | `global` gives one hull; `component` gives two |
45
+ | `narrow-neck` | does a thin connecting polygon remain covered? | one valid hull covering the neck and both ends |
46
+ | `ring-with-hole` | should a semantic hole remain open? | `allow_holes=True` keeps it; the default fills it |
47
+
48
+ Generated inputs, outputs, and JSON reports are placed under
49
+ `examples/generated/`. To run the standard case through the CLI:
50
+
51
+ ```bash
52
+ concavewrap build examples/generated/forest-patches.gpkg \
53
+ --layer areas \
54
+ --ratio 0.25 \
55
+ --output examples/generated/forest-hull-cli.gpkg \
56
+ --diagnostics examples/generated/forest-hull-cli.json
57
+ ```
58
+
59
+ Expected audit values are printed and asserted by the script, then saved in
60
+ `summary.json`. No external or real-world data is used.
61
+
62
+ ## Ratio and policies
63
+
64
+ `--ratio` follows GEOS/Shapely semantics:
65
+
66
+ | value | behavior |
67
+ |---:|---|
68
+ | `0` | most concave result available from the input vertices |
69
+ | `0.25` | useful starting point for irregular polygon collections |
70
+ | `1` | convex hull |
71
+
72
+ The ratio is dimensionless. It is not an alpha radius or a distance threshold,
73
+ so values from alpha-shape tools cannot be copied directly.
74
+
75
+ | option | choices | meaning |
76
+ |---|---|---|
77
+ | `--scope` | `global`, `component` | bridge all polygons in a group, or keep disconnected dissolved components separate |
78
+ | `--group-by FIELD` | any scalar field | build an independent result for each attribute value |
79
+ | `--allow-holes` | flag | retain source holes and permit hull holes; without it all holes are filled |
80
+ | `--invalid` | `repair`, `error` | repair invalid polygonal geometry with GEOS or stop |
81
+ | `--fallback` | `convex`, `error` | use and report the convex hull if the concave operation fails, or stop |
82
+
83
+ ## Guarantees
84
+
85
+ For every output record, `concavewrap` verifies that:
86
+
87
+ - the result is valid polygonal geometry;
88
+ - the result covers the complete input polygon area, not only its vertices;
89
+ - the result does not extend beyond the convex hull, within floating-point tolerance;
90
+ - the chosen hole, grouping, component, repair, and fallback policies are recorded;
91
+ - input ordering determines stable group and component ordering.
92
+
93
+ ## Output fields
94
+
95
+ | field | meaning |
96
+ |---|---|
97
+ | `hull_id` | stable one-based output identifier |
98
+ | `group_value` | text representation of the grouping value, or null |
99
+ | `source_features` | number of input features contributing to the hull |
100
+ | `repaired_features` | number of invalid contributors repaired |
101
+ | `input_area` | dissolved source area in CRS square units |
102
+ | `hull_area` | output hull area |
103
+ | `fill_area` | area added around or between source polygons |
104
+ | `convex_area` | area of the corresponding convex hull |
105
+ | `hull_to_convex_ratio` | output area divided by convex-hull area |
106
+ | `fallback_used` | whether the convex fallback was used |
107
+ | `fallback_reason` | captured failure message, if any |
108
+ | `ratio`, `allow_holes`, `scope` | effective construction settings |
109
+ | `covers_input` | final invariant check |
110
+
111
+ ## Python API
112
+
113
+ ```python
114
+ import geopandas as gpd
115
+ from concavewrap import HullOptions, HullResult, build_hulls
116
+
117
+ areas = gpd.read_file("areas.gpkg", layer="areas")
118
+ result: HullResult = build_hulls(
119
+ areas,
120
+ HullOptions(ratio=0.25, scope="global", allow_holes=False),
121
+ )
122
+ result.hulls.to_file("hulls.gpkg", layer="hulls", driver="GPKG")
123
+ print(result.report())
124
+ ```
125
+
126
+ The stable public interface is `build_hulls(...)`, `HullOptions`, `HullResult`,
127
+ and `HullDiagnostic`.
128
+
129
+ ## Limits
130
+
131
+ - Input geometries must be Polygon or MultiPolygon.
132
+ - A projected CRS with horizontal units in metres is required so that area audit
133
+ values are meaningful and comparable.
134
+ - `component` scope dissolves touching and overlapping polygons before identifying
135
+ disconnected components.
136
+ - Concave hulls are not unique across algorithms. This package uses the GEOS
137
+ algorithm exposed by Shapely and records its ratio explicitly.
138
+ - A hull is a generalization. Always inspect results for sparse samples, narrow
139
+ necks, very large gaps, and geometries whose holes have semantic meaning.
140
+
141
+ Run `concavewrap --help` for all options. Exit code `0` means success and `2`
142
+ means invalid input or a processing failure.
143
+
144
+ The pre-release and launch checks are listed in
145
+ [`docs/release-checklist.md`](docs/release-checklist.md).
146
+
147
+ ## Development
148
+
149
+ ```bash
150
+ python -m pip install -e ".[test]"
151
+ python -m ruff check .
152
+ python -m ruff format --check .
153
+ python -m pytest
154
+ ```
155
+
156
+ Copyright 2026 Alena Nikitina. Licensed under the [Apache License 2.0](LICENSE).
@@ -0,0 +1,8 @@
1
+ # Security policy
2
+
3
+ Only the latest released version receives security fixes.
4
+
5
+ Please do not open a public issue for a suspected vulnerability. Use GitHub's
6
+ private vulnerability reporting feature on this repository instead. Include a
7
+ minimal reproduction, affected versions, and the expected impact. You can expect
8
+ an acknowledgement within seven days.
@@ -0,0 +1,23 @@
1
+ <svg xmlns="http://www.w3.org/2000/svg" width="960" height="330" viewBox="0 0 960 330" role="img" aria-labelledby="title desc">
2
+ <title id="title">Polygon patches converted to a concave hull</title>
3
+ <desc id="desc">Four polygon patches on the left and a covering concave hull with the source areas on the right.</desc>
4
+ <rect width="960" height="330" fill="#f8fafc"/>
5
+ <text x="70" y="42" font-family="sans-serif" font-size="22" font-weight="700" fill="#0f172a">Input polygon patches</text>
6
+ <text x="610" y="42" font-family="sans-serif" font-size="22" font-weight="700" fill="#0f172a">Verified concave hull</text>
7
+ <g fill="#60a5fa" stroke="#1d4ed8" stroke-width="3">
8
+ <rect x="80" y="85" width="90" height="170" rx="3"/>
9
+ <rect x="170" y="85" width="205" height="50" rx="3"/>
10
+ <rect x="320" y="135" width="55" height="75" rx="3"/>
11
+ <rect x="170" y="215" width="95" height="40" rx="3"/>
12
+ </g>
13
+ <path d="M585 255 L585 85 L880 85 L880 210 L805 210 L805 165 L675 165 L675 255 Z" fill="#99f6e4" stroke="#0f766e" stroke-width="5" stroke-linejoin="round"/>
14
+ <g fill="#60a5fa" fill-opacity="0.75" stroke="#1d4ed8" stroke-width="2">
15
+ <rect x="585" y="85" width="90" height="170" rx="3"/>
16
+ <rect x="675" y="85" width="205" height="50" rx="3"/>
17
+ <rect x="825" y="135" width="55" height="75" rx="3"/>
18
+ <rect x="675" y="215" width="95" height="40" rx="3"/>
19
+ </g>
20
+ <path d="M455 165 H520" stroke="#334155" stroke-width="5"/>
21
+ <path d="M510 150 L530 165 L510 180" fill="none" stroke="#334155" stroke-width="5" stroke-linecap="round" stroke-linejoin="round"/>
22
+ <text x="303" y="303" font-family="sans-serif" font-size="17" fill="#475569">The output covers every source area and stays inside the convex hull.</text>
23
+ </svg>
@@ -0,0 +1,24 @@
1
+ # Release checklist
2
+
3
+ ## Before making the repository public
4
+
5
+ - [ ] CI passes on Windows and Linux with Python 3.11, 3.12, and 3.13.
6
+ - [ ] `python examples/run_examples.py` reproduces every documented scenario.
7
+ - [ ] Ruff, pytest, wheel/sdist build, Twine metadata, and clean-wheel smoke tests pass.
8
+ - [ ] README commands work from a fresh clone and use only synthetic data.
9
+ - [ ] The repository contains no private data, credentials, unrelated product names, or
10
+ files without a clear redistribution right.
11
+ - [ ] Version `0.1.0`, changelog, citation metadata, URLs, license, and topics agree.
12
+
13
+ ## Publication session
14
+
15
+ - [ ] Confirm the PyPI pending Trusted Publisher targets this repository,
16
+ `.github/workflows/release.yml`, and the `pypi` environment.
17
+ - [ ] Make the repository public and enable required CI on `main`, with force-push and
18
+ branch deletion disabled.
19
+ - [ ] Publish GitHub Release `v0.1.0`.
20
+ - [ ] Confirm the release workflow publishes the already-built artifacts through OIDC.
21
+ - [ ] Install `concavewrap-geo` from PyPI in fresh Windows and Linux environments and run
22
+ `concavewrap --version` plus one documented example.
23
+ - [ ] Confirm GitHub and PyPI show Apache-2.0 and correct source, issue, and homepage URLs.
24
+ - [ ] Pin the repository only after the PyPI installation check passes.