brushline 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 (192) hide show
  1. brushline-0.1.0/CITATION.cff +10 -0
  2. brushline-0.1.0/CONTRIBUTING.md +63 -0
  3. brushline-0.1.0/LICENSE +201 -0
  4. brushline-0.1.0/MANIFEST.in +5 -0
  5. brushline-0.1.0/PKG-INFO +162 -0
  6. brushline-0.1.0/README.md +112 -0
  7. brushline-0.1.0/RELEASE_NOTES.md +65 -0
  8. brushline-0.1.0/brushline/__init__.py +7 -0
  9. brushline-0.1.0/brushline/build/__init__.py +7 -0
  10. brushline-0.1.0/brushline/build/compiler.py +278 -0
  11. brushline-0.1.0/brushline/cli.py +476 -0
  12. brushline-0.1.0/brushline/demo/__init__.py +1 -0
  13. brushline-0.1.0/brushline/demo/builder.py +103 -0
  14. brushline-0.1.0/brushline/demo/deploy.py +32 -0
  15. brushline-0.1.0/brushline/demo/pilot.py +80 -0
  16. brushline-0.1.0/brushline/demo/portfolio.py +103 -0
  17. brushline-0.1.0/brushline/demo/validation.py +48 -0
  18. brushline-0.1.0/brushline/exchange/__init__.py +31 -0
  19. brushline-0.1.0/brushline/exchange/audit.py +63 -0
  20. brushline-0.1.0/brushline/exchange/bids.py +67 -0
  21. brushline-0.1.0/brushline/exchange/contractor.py +60 -0
  22. brushline-0.1.0/brushline/exchange/owner.py +51 -0
  23. brushline-0.1.0/brushline/exchange/plan.py +102 -0
  24. brushline-0.1.0/brushline/exchange/validation.py +131 -0
  25. brushline-0.1.0/brushline/fixtures/__init__.py +19 -0
  26. brushline-0.1.0/brushline/fixtures/synthetic.py +1042 -0
  27. brushline-0.1.0/brushline/instance_ops.py +305 -0
  28. brushline-0.1.0/brushline/instance_template.py +81 -0
  29. brushline-0.1.0/brushline/integrations/__init__.py +23 -0
  30. brushline-0.1.0/brushline/integrations/canopy.py +700 -0
  31. brushline-0.1.0/brushline/integrations/capabilities.py +950 -0
  32. brushline-0.1.0/brushline/integrations/catalogue.py +805 -0
  33. brushline-0.1.0/brushline/integrations/femic.py +318 -0
  34. brushline-0.1.0/brushline/integrations/fetch.py +1112 -0
  35. brushline-0.1.0/brushline/integrations/freshforge.py +447 -0
  36. brushline-0.1.0/brushline/integrations/lidar.py +800 -0
  37. brushline-0.1.0/brushline/integrations/lidar_benchmark.py +466 -0
  38. brushline-0.1.0/brushline/integrations/lidar_coverage.py +533 -0
  39. brushline-0.1.0/brushline/integrations/terrain.py +586 -0
  40. brushline-0.1.0/brushline/model/__init__.py +71 -0
  41. brushline-0.1.0/brushline/model/archive.py +264 -0
  42. brushline-0.1.0/brushline/model/corridor.py +559 -0
  43. brushline-0.1.0/brushline/model/demo.py +217 -0
  44. brushline-0.1.0/brushline/model/plan.py +337 -0
  45. brushline-0.1.0/brushline/model/run.py +164 -0
  46. brushline-0.1.0/brushline/model/schema.py +587 -0
  47. brushline-0.1.0/brushline/model/state.py +530 -0
  48. brushline-0.1.0/brushline/model/timeline.py +167 -0
  49. brushline-0.1.0/brushline/model/validation.py +101 -0
  50. brushline-0.1.0/brushline/monitoring/__init__.py +69 -0
  51. brushline-0.1.0/brushline/monitoring/mission.py +282 -0
  52. brushline-0.1.0/brushline/monitoring/observation.py +165 -0
  53. brushline-0.1.0/brushline/monitoring/recalibration.py +107 -0
  54. brushline-0.1.0/brushline/monitoring/replan.py +58 -0
  55. brushline-0.1.0/brushline/monitoring/validation.py +102 -0
  56. brushline-0.1.0/brushline/monitoring/value.py +225 -0
  57. brushline-0.1.0/brushline/optimization/__init__.py +199 -0
  58. brushline-0.1.0/brushline/optimization/adapter.py +877 -0
  59. brushline-0.1.0/brushline/optimization/budget.py +551 -0
  60. brushline-0.1.0/brushline/optimization/evaluator.py +966 -0
  61. brushline-0.1.0/brushline/optimization/formulation.py +681 -0
  62. brushline-0.1.0/brushline/optimization/operators.py +910 -0
  63. brushline-0.1.0/brushline/optimization/pareto.py +511 -0
  64. brushline-0.1.0/brushline/optimization/telemetry.py +673 -0
  65. brushline-0.1.0/brushline/optimization/validation.py +349 -0
  66. brushline-0.1.0/brushline/resources/__init__.py +3 -0
  67. brushline-0.1.0/brushline/resources/instance/QUICKSTART.md +28 -0
  68. brushline-0.1.0/brushline/resources/instance/README.md +34 -0
  69. brushline-0.1.0/brushline/resources/instance/__init__.py +3 -0
  70. brushline-0.1.0/brushline/resources/instance/config/brushline/rebuild.steps.yaml +57 -0
  71. brushline-0.1.0/brushline/resources/instance/config/brushline/scenario.yaml +11 -0
  72. brushline-0.1.0/brushline/resources/instance/config/brushline/standards.yaml +5 -0
  73. brushline-0.1.0/brushline/resources/instance/config/brushline/targets.yaml +5 -0
  74. brushline-0.1.0/brushline/resources/instance/config/rebuild.allowlist.yaml +8 -0
  75. brushline-0.1.0/brushline/resources/instance/config/rebuild.spec.yaml +78 -0
  76. brushline-0.1.0/brushline/resources/instance/evidence/README.md +11 -0
  77. brushline-0.1.0/brushline/resources/instance/runbooks/REBUILD_RUNBOOK.md +54 -0
  78. brushline-0.1.0/brushline/resources/instance/tests/README.md +9 -0
  79. brushline-0.1.0/brushline/run.py +128 -0
  80. brushline-0.1.0/brushline/sim/__init__.py +14 -0
  81. brushline-0.1.0/brushline/sim/engine.py +363 -0
  82. brushline-0.1.0/brushline/sim/schedule.py +124 -0
  83. brushline-0.1.0/brushline/state_init.py +859 -0
  84. brushline-0.1.0/brushline/strategic/__init__.py +159 -0
  85. brushline-0.1.0/brushline/strategic/bau.py +453 -0
  86. brushline-0.1.0/brushline/strategic/dynamic_program.py +492 -0
  87. brushline-0.1.0/brushline/strategic/monitoring.py +417 -0
  88. brushline-0.1.0/brushline/strategic/portfolio.py +787 -0
  89. brushline-0.1.0/brushline/strategic/reports.py +294 -0
  90. brushline-0.1.0/brushline/strategic/scenario.py +462 -0
  91. brushline-0.1.0/brushline/strategic/validation.py +450 -0
  92. brushline-0.1.0/brushline/tactical/__init__.py +132 -0
  93. brushline-0.1.0/brushline/tactical/access.py +219 -0
  94. brushline-0.1.0/brushline/tactical/fhops.py +251 -0
  95. brushline-0.1.0/brushline/tactical/operations.py +252 -0
  96. brushline-0.1.0/brushline/tactical/program.py +323 -0
  97. brushline-0.1.0/brushline/tactical/resources.py +283 -0
  98. brushline-0.1.0/brushline/tactical/timeline.py +220 -0
  99. brushline-0.1.0/brushline/tactical/validation.py +389 -0
  100. brushline-0.1.0/brushline/vegetation/__init__.py +129 -0
  101. brushline-0.1.0/brushline/vegetation/calibration.py +710 -0
  102. brushline-0.1.0/brushline/vegetation/growth.py +592 -0
  103. brushline-0.1.0/brushline/vegetation/hazards.py +644 -0
  104. brushline-0.1.0/brushline/vegetation/model_card.py +475 -0
  105. brushline-0.1.0/brushline/vegetation/state_space.py +703 -0
  106. brushline-0.1.0/brushline/vegetation/treatment.py +589 -0
  107. brushline-0.1.0/brushline/vegetation/validation.py +704 -0
  108. brushline-0.1.0/brushline/verification/__init__.py +1 -0
  109. brushline-0.1.0/brushline/verification/acceptance.py +251 -0
  110. brushline-0.1.0/brushline/web/__init__.py +4 -0
  111. brushline-0.1.0/brushline/web/model_builder.py +1362 -0
  112. brushline-0.1.0/brushline/web/static/model-builder.css +176 -0
  113. brushline-0.1.0/brushline/web/static/model-builder.html +142 -0
  114. brushline-0.1.0/brushline/web/static/model-builder.js +509 -0
  115. brushline-0.1.0/brushline/web/static/studio.css +1 -0
  116. brushline-0.1.0/brushline/web/static/studio.html +13 -0
  117. brushline-0.1.0/brushline/web/static/studio.js +41 -0
  118. brushline-0.1.0/brushline/web/studio.py +233 -0
  119. brushline-0.1.0/brushline.egg-info/PKG-INFO +162 -0
  120. brushline-0.1.0/brushline.egg-info/SOURCES.txt +190 -0
  121. brushline-0.1.0/brushline.egg-info/dependency_links.txt +1 -0
  122. brushline-0.1.0/brushline.egg-info/entry_points.txt +5 -0
  123. brushline-0.1.0/brushline.egg-info/requires.txt +31 -0
  124. brushline-0.1.0/brushline.egg-info/top_level.txt +1 -0
  125. brushline-0.1.0/pyproject.toml +135 -0
  126. brushline-0.1.0/setup.cfg +4 -0
  127. brushline-0.1.0/tests/test_adapter.py +330 -0
  128. brushline-0.1.0/tests/test_api_docstrings.py +65 -0
  129. brushline-0.1.0/tests/test_artifact_contracts.py +534 -0
  130. brushline-0.1.0/tests/test_brushline_cli.py +40 -0
  131. brushline-0.1.0/tests/test_canopy_support.py +665 -0
  132. brushline-0.1.0/tests/test_capabilities.py +618 -0
  133. brushline-0.1.0/tests/test_catalogue.py +416 -0
  134. brushline-0.1.0/tests/test_check_workflow.py +809 -0
  135. brushline-0.1.0/tests/test_cli.py +75 -0
  136. brushline-0.1.0/tests/test_contracts.py +204 -0
  137. brushline-0.1.0/tests/test_corridor_contract.py +369 -0
  138. brushline-0.1.0/tests/test_dashboard.py +217 -0
  139. brushline-0.1.0/tests/test_dataset_schema.py +385 -0
  140. brushline-0.1.0/tests/test_demo.py +20 -0
  141. brushline-0.1.0/tests/test_dynamic_program.py +212 -0
  142. brushline-0.1.0/tests/test_evaluator.py +469 -0
  143. brushline-0.1.0/tests/test_exchange.py +38 -0
  144. brushline-0.1.0/tests/test_exchange_plan.py +52 -0
  145. brushline-0.1.0/tests/test_femic_boundary.py +131 -0
  146. brushline-0.1.0/tests/test_fetch_plan.py +767 -0
  147. brushline-0.1.0/tests/test_formulation.py +278 -0
  148. brushline-0.1.0/tests/test_freshforge_provider.py +245 -0
  149. brushline-0.1.0/tests/test_growth_model.py +320 -0
  150. brushline-0.1.0/tests/test_hazard_indicators.py +413 -0
  151. brushline-0.1.0/tests/test_instance_ops.py +246 -0
  152. brushline-0.1.0/tests/test_instance_template.py +163 -0
  153. brushline-0.1.0/tests/test_lidar_benchmark.py +232 -0
  154. brushline-0.1.0/tests/test_lidar_bundle.py +488 -0
  155. brushline-0.1.0/tests/test_lidar_coverage.py +348 -0
  156. brushline-0.1.0/tests/test_mission.py +78 -0
  157. brushline-0.1.0/tests/test_model_builder.py +498 -0
  158. brushline-0.1.0/tests/test_model_card.py +263 -0
  159. brushline-0.1.0/tests/test_monitoring_loop.py +48 -0
  160. brushline-0.1.0/tests/test_monitoring_value.py +56 -0
  161. brushline-0.1.0/tests/test_observation.py +44 -0
  162. brushline-0.1.0/tests/test_operators.py +524 -0
  163. brushline-0.1.0/tests/test_optimization_budget.py +210 -0
  164. brushline-0.1.0/tests/test_optimization_telemetry.py +374 -0
  165. brushline-0.1.0/tests/test_optimization_validation.py +219 -0
  166. brushline-0.1.0/tests/test_pareto.py +250 -0
  167. brushline-0.1.0/tests/test_properties.py +370 -0
  168. brushline-0.1.0/tests/test_prototype.py +178 -0
  169. brushline-0.1.0/tests/test_state_contract.py +362 -0
  170. brushline-0.1.0/tests/test_state_initialization.py +692 -0
  171. brushline-0.1.0/tests/test_state_space.py +286 -0
  172. brushline-0.1.0/tests/test_strategic_bau.py +223 -0
  173. brushline-0.1.0/tests/test_strategic_monitoring.py +179 -0
  174. brushline-0.1.0/tests/test_strategic_portfolio.py +254 -0
  175. brushline-0.1.0/tests/test_strategic_reports.py +319 -0
  176. brushline-0.1.0/tests/test_strategic_scenario.py +257 -0
  177. brushline-0.1.0/tests/test_strategic_validation.py +150 -0
  178. brushline-0.1.0/tests/test_studio.py +48 -0
  179. brushline-0.1.0/tests/test_synthetic_fixture.py +199 -0
  180. brushline-0.1.0/tests/test_tactical_access.py +71 -0
  181. brushline-0.1.0/tests/test_tactical_fhops.py +83 -0
  182. brushline-0.1.0/tests/test_tactical_operations.py +120 -0
  183. brushline-0.1.0/tests/test_tactical_program.py +156 -0
  184. brushline-0.1.0/tests/test_tactical_resources.py +108 -0
  185. brushline-0.1.0/tests/test_tactical_timeline.py +153 -0
  186. brushline-0.1.0/tests/test_tactical_validation.py +73 -0
  187. brushline-0.1.0/tests/test_terrain_support.py +559 -0
  188. brushline-0.1.0/tests/test_treatment_calibration.py +326 -0
  189. brushline-0.1.0/tests/test_treatment_transitions.py +309 -0
  190. brushline-0.1.0/tests/test_vegetation_validation.py +347 -0
  191. brushline-0.1.0/tests/test_verification.py +27 -0
  192. brushline-0.1.0/tests/test_workflow.py +19 -0
@@ -0,0 +1,10 @@
1
+ cff-version: 1.2.0
2
+ message: "If you use this software, please cite the repository."
3
+ title: "Brushline: vegetation management decision support for linear infrastructure corridors"
4
+ abstract: "A decision support system for optimal vegetation management along linear infrastructure corridors in forested landscapes. It couples shrub and young-tree growth, treatment transitions, strategic, tactical, and operational planning, adaptive remote monitoring, a multi-objective metaheuristic search, and an interactive planning studio for asset owners and contractors."
5
+ authors:
6
+ - name: "UBC FRESH Lab"
7
+ repository-code: "https://github.com/UBC-FRESH/brushline"
8
+ url: "https://github.com/UBC-FRESH/brushline"
9
+ license: "Apache-2.0"
10
+ version: "0.1.0"
@@ -0,0 +1,63 @@
1
+ # Contributing to Brushline
2
+
3
+ Read `AGENTS.md` and `ROADMAP.md` before non-trivial work. The domain rules at the end of
4
+ `AGENTS.md` are part of the design, not style advice.
5
+
6
+ ## Setup
7
+
8
+ ```bash
9
+ python -m venv .venv
10
+ . .venv/bin/activate
11
+ python -m pip install -r requirements-dev.txt
12
+ python -m pip install -e .
13
+ pre-commit install
14
+ ```
15
+
16
+ The pre-commit hooks call `python` from `PATH`, so commit from a shell where the environment is
17
+ active. A commit from a shell without it runs the hooks in the system Python, which lacks the dev
18
+ tools, and the hooks fail.
19
+
20
+ Optional extras are installed only when a task needs them:
21
+
22
+ ```bash
23
+ python -m pip install -e ".[opt]" # fresh-solutions metaheuristic engine
24
+ python -m pip install -e ".[web]" # FastAPI, MapLibre assets, vector tiles
25
+ ```
26
+
27
+ ## The green dashboard
28
+
29
+ Run `python scripts/dashboard.py` before each commit. It must be green. Any change from green is
30
+ investigated and fixed immediately, with no exceptions. The pre-commit hooks run the same checks on
31
+ each commit.
32
+
33
+ ## Workflow
34
+
35
+ - Work on the branch for the active phase, named `feature/p<n>-<slug>`.
36
+ - Start each commit message with the task ID, for example `P0.1 adapt the contract`.
37
+ - Write every function with full type annotations and a numpy-style docstring, and add unit tests for
38
+ it in the same change set.
39
+ - Keep `ROADMAP.md`, `CHANGE_LOG.md`, `notes/`, and the matching GitHub issues in step with the work.
40
+ - Open pull requests with `Part of #<parent issue>` in the body. CI must be green. A merge happens only
41
+ as part of an approved phase close-out.
42
+
43
+ ## Domain guardrails
44
+
45
+ - A segment is the decision unit. Do not compile at a span or treatment-unit level.
46
+ - A vegetation state carries its uncertainty. Do not reduce a plan to a single point estimate without
47
+ saying so.
48
+ - A treatment is a transition. Do not model it as a reset to zero vegetation.
49
+ - Monitoring is a decision. Do not hard-code a fixed flight calendar.
50
+ - Every reported incumbent must replay exactly from its evidence record.
51
+ - The studio reads artifacts. Do not put model state in the web service.
52
+ - Keep third-party code and documentation out of the repository. Adapters are interfaces, not copies.
53
+
54
+ ## Control characters and public safety
55
+
56
+ - Write issue and pull request bodies to files, and post them with `--body-file`. Do not build them from
57
+ escaped strings.
58
+ - Use LF line endings.
59
+ - Run `python scripts/check_workflow.py` before you push. To check one body file, run
60
+ `python scripts/check_workflow.py --files path/to/body.md`.
61
+ - Keep private data, credentials, raw transcripts, and machine-specific paths out of the repository.
62
+ - Do not commit real asset, contractor, or personal data. Use synthetic fixtures or sanitized extracts
63
+ with a recorded provenance note.
@@ -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 2026 UBC FRESH Lab
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,5 @@
1
+ include RELEASE_NOTES.md
2
+ include README.md
3
+ include LICENSE
4
+ include CONTRIBUTING.md
5
+ include CITATION.cff
@@ -0,0 +1,162 @@
1
+ Metadata-Version: 2.4
2
+ Name: brushline
3
+ Version: 0.1.0
4
+ Summary: Decision support for vegetation management along linear infrastructure corridors
5
+ Author-email: UBC FRESH Lab <noreply@example.org>
6
+ License-Expression: Apache-2.0
7
+ Project-URL: Homepage, https://github.com/UBC-FRESH/brushline
8
+ Project-URL: Documentation, https://ubc-fresh.github.io/brushline/
9
+ Project-URL: Repository, https://github.com/UBC-FRESH/brushline
10
+ Project-URL: Issues, https://github.com/UBC-FRESH/brushline/issues
11
+ Keywords: forestry,vegetation management,rights-of-way,linear infrastructure,optimization,metaheuristics,remote sensing,decision support
12
+ Classifier: Development Status :: 2 - Pre-Alpha
13
+ Classifier: Intended Audience :: Science/Research
14
+ Classifier: Operating System :: POSIX :: Linux
15
+ Classifier: Programming Language :: Python :: 3
16
+ Classifier: Programming Language :: Python :: 3.11
17
+ Classifier: Programming Language :: Python :: 3.12
18
+ Classifier: Topic :: Scientific/Engineering
19
+ Classifier: Typing :: Typed
20
+ Requires-Python: >=3.11
21
+ Description-Content-Type: text/markdown
22
+ License-File: LICENSE
23
+ Requires-Dist: typer>=0.12
24
+ Requires-Dist: rich>=13.7
25
+ Requires-Dist: pydantic>=2.7
26
+ Requires-Dist: pandas>=2.2
27
+ Requires-Dist: numpy>=1.26
28
+ Requires-Dist: pyarrow>=15
29
+ Requires-Dist: pyyaml>=6
30
+ Requires-Dist: packaging>=24
31
+ Provides-Extra: geo
32
+ Requires-Dist: geopandas>=0.14; extra == "geo"
33
+ Requires-Dist: pyogrio>=0.9; extra == "geo"
34
+ Requires-Dist: shapely>=2.0; extra == "geo"
35
+ Provides-Extra: opt
36
+ Requires-Dist: fresh-solutions<0.10,>=0.9.3; extra == "opt"
37
+ Provides-Extra: femic
38
+ Requires-Dist: femic==0.2.0a1; extra == "femic"
39
+ Requires-Dist: freshforge==0.1.0a5; extra == "femic"
40
+ Provides-Extra: freshforge
41
+ Requires-Dist: freshforge==0.1.0a5; extra == "freshforge"
42
+ Provides-Extra: web
43
+ Requires-Dist: fastapi>=0.110; extra == "web"
44
+ Requires-Dist: uvicorn>=0.29; extra == "web"
45
+ Requires-Dist: mapbox-vector-tile>=2.1; extra == "web"
46
+ Requires-Dist: mercantile>=1.2; extra == "web"
47
+ Requires-Dist: shapely>=2.0; extra == "web"
48
+ Requires-Dist: pyproj>=3.6; extra == "web"
49
+ Dynamic: license-file
50
+
51
+ # Brushline
52
+
53
+ Brushline is decision support for vegetation management along linear infrastructure corridors in
54
+ forested landscapes: powerlines, pipelines, roads, railways, and the rights-of-way that keep them
55
+ accessible and safe.
56
+
57
+ The system couples a shrub and young-tree growth model, treatment transitions, strategic, tactical, and
58
+ operational planning, adaptive remote monitoring, and a multi-objective metaheuristic search. One
59
+ versioned plan artifact serves both the asset owner who hires the work and the contractor who bids on
60
+ it, so a budget, a schedule, and a bid can be inspected against the same evidence.
61
+
62
+ ## The problem
63
+
64
+ A utility or pipeline operator may manage thousands of kilometres of corridor through productive
65
+ forest. Vegetation that is left too long reduces clearance, blocks access, raises fire risk, and
66
+ threatens reliability. Treat it too often and the budget is wasted. The usual answer is a fixed cycle
67
+ and a spreadsheet, with each contractor bidding from a different set of assumptions.
68
+
69
+ Two things make the problem hard:
70
+
71
+ - Open growth and yield models for shrubs and young trees are scarce. Brushline must carry its own
72
+ calibrated state-transition model, and must state its uncertainty.
73
+ - The joint choice of where and when to treat, and where and when to monitor, is an NP-hard
74
+ combinatorial problem with budget, capacity, access, spatial, temporal, and service constraints.
75
+ Brushline therefore commits to a metaheuristic search framework and a Pareto archive of trade-offs,
76
+ not to a claim of optimality.
77
+
78
+ ## What the system will do
79
+
80
+ - **Build a corridor model.** Segments are the decision unit; spans and treatment units are runtime
81
+ aggregates. Each segment carries site, vegetation, treatment, access, and observation history.
82
+ - **Grow and treat vegetation.** A state is a distribution over interpretable classes, with
83
+ continuous summaries. Treatments are transitions with method-specific efficacy, selectivity, and
84
+ regrowth.
85
+ - **Plan at three scales.** Strategic plans set budget, service levels, risk appetite, and monitoring
86
+ policy over 10 to 30 years. Tactical plans set multi-year treatment programs, contractor capacity,
87
+ and access. Operational plans set work-ready treatment units, methods, and schedules.
88
+ - **Decide when to monitor.** Flight frequency, route, sensor, and sampling intensity are decision
89
+ variables priced by their expected value of information, and observations recalibrate the growth
90
+ model.
91
+ - **Search the trade-offs.** A `fresh-solutions` problem adapter supplies exact evaluation, moves, and
92
+ undo; the engine supplies local search, population search, checkpoints, seeds, telemetry, and exact
93
+ replay. A Pareto archive keeps the cost, risk, service, and uncertainty trade-offs.
94
+ - **Compare owner and contractor views.** A plan carries a line-item cost build-up, assumptions,
95
+ quantities, rates, and provenance. A bid is an annotated plan, not a separate spreadsheet.
96
+ - **Explore it in a planning studio.** One optional FastAPI service and one static browser shell read
97
+ the run artifacts. MapLibre carries the 2D corridor map, Three.js carries the 3D operations scene,
98
+ and checked skins cover owner-strategic, tactical, operations, contractor, monitoring, and reviewer
99
+ roles. The studio animates deployment and explores the Pareto front without owning model state.
100
+
101
+ ## Status
102
+
103
+ Phase 0 (bootstrap and scope) and Phase 1 (contracts and prototype) are complete and merged. Phase 2
104
+ (FEMIC-extended instance builder) is active: the repository is pinning the FEMIC provider surface and
105
+ building the map-to-instance workflow on top of it. It does not yet have a usable vegetation model or
106
+ planner. `ROADMAP.md` is the plan of record, and the GitHub issues carry the live status.
107
+
108
+ Brushline is a working name. It is easy to rename before the first public release.
109
+
110
+ ## Quick start
111
+
112
+ ```bash
113
+ python -m venv .venv
114
+ . .venv/bin/activate
115
+ python -m pip install -r requirements-dev.txt
116
+ python -m pip install -e .
117
+ brushline --help
118
+ python scripts/dashboard.py
119
+ ```
120
+
121
+ The dashboard runs lint, format, strict types, tests with a coverage gate, the workflow validator, the
122
+ docs build, and the docstring audit. Every commit leaves it green.
123
+
124
+ ## How this project works
125
+
126
+ This project follows the UBC-FRESH dev workflow. Work is planned as phases, tasks, and subtasks in
127
+ `ROADMAP.md`, mirrored in GitHub issues, and recorded in `CHANGE_LOG.md`. The agent operating contract
128
+ is in `AGENTS.md`. Read `AGENTS.md`, then `ROADMAP.md`, before you change anything.
129
+
130
+ ## Repository map
131
+
132
+ | Path | Purpose |
133
+ | --- | --- |
134
+ | `AGENTS.md` | Operating contract for coding agents |
135
+ | `ROADMAP.md` | Plan of record and issue tracker map |
136
+ | `CHANGE_LOG.md` | Dated narrative of changes |
137
+ | `brushline/` | The Python package and command line |
138
+ | `docs/` | Documentation site, including the design index |
139
+ | `notes/design/` | Scope, architecture, optimization, and UI design records |
140
+ | `notes/adr/` | Architecture decisions |
141
+ | `notes/reports/` | Phase close-out reports |
142
+ | `scripts/check_workflow.py` | Workflow validator |
143
+ | `tests/` | pytest suite, including the planning-surface self-check |
144
+
145
+ ## Relationship to the other FRESH tools
146
+
147
+ Brushline is a sibling of WS4, FHOPS, the FRESH urban-forest lab, and Fresh Solutions. It borrows
148
+ patterns, not internals:
149
+
150
+ - **WS4** supplies the pattern for a compiled, inspectable dataset, spatial decisions inside the model,
151
+ artifact-based runs, and the web shell.
152
+ - **FHOPS** supplies the pattern for tactical and operational planning, machine and crew productivity,
153
+ and 3D operations visualization.
154
+ - **Fresh Solutions** supplies the metaheuristic engine and the exact replay contract.
155
+ - **The FRESH urban-forest lab** supplies the pattern for a 2D/3D browser studio with vendored,
156
+ offline-capable map and scene libraries.
157
+
158
+ The adapters are versioned and optional. Brushline stays installable without the other tools.
159
+
160
+ ## License
161
+
162
+ Apache-2.0. See [`LICENSE`](LICENSE) and [`CITATION.cff`](CITATION.cff).
@@ -0,0 +1,112 @@
1
+ # Brushline
2
+
3
+ Brushline is decision support for vegetation management along linear infrastructure corridors in
4
+ forested landscapes: powerlines, pipelines, roads, railways, and the rights-of-way that keep them
5
+ accessible and safe.
6
+
7
+ The system couples a shrub and young-tree growth model, treatment transitions, strategic, tactical, and
8
+ operational planning, adaptive remote monitoring, and a multi-objective metaheuristic search. One
9
+ versioned plan artifact serves both the asset owner who hires the work and the contractor who bids on
10
+ it, so a budget, a schedule, and a bid can be inspected against the same evidence.
11
+
12
+ ## The problem
13
+
14
+ A utility or pipeline operator may manage thousands of kilometres of corridor through productive
15
+ forest. Vegetation that is left too long reduces clearance, blocks access, raises fire risk, and
16
+ threatens reliability. Treat it too often and the budget is wasted. The usual answer is a fixed cycle
17
+ and a spreadsheet, with each contractor bidding from a different set of assumptions.
18
+
19
+ Two things make the problem hard:
20
+
21
+ - Open growth and yield models for shrubs and young trees are scarce. Brushline must carry its own
22
+ calibrated state-transition model, and must state its uncertainty.
23
+ - The joint choice of where and when to treat, and where and when to monitor, is an NP-hard
24
+ combinatorial problem with budget, capacity, access, spatial, temporal, and service constraints.
25
+ Brushline therefore commits to a metaheuristic search framework and a Pareto archive of trade-offs,
26
+ not to a claim of optimality.
27
+
28
+ ## What the system will do
29
+
30
+ - **Build a corridor model.** Segments are the decision unit; spans and treatment units are runtime
31
+ aggregates. Each segment carries site, vegetation, treatment, access, and observation history.
32
+ - **Grow and treat vegetation.** A state is a distribution over interpretable classes, with
33
+ continuous summaries. Treatments are transitions with method-specific efficacy, selectivity, and
34
+ regrowth.
35
+ - **Plan at three scales.** Strategic plans set budget, service levels, risk appetite, and monitoring
36
+ policy over 10 to 30 years. Tactical plans set multi-year treatment programs, contractor capacity,
37
+ and access. Operational plans set work-ready treatment units, methods, and schedules.
38
+ - **Decide when to monitor.** Flight frequency, route, sensor, and sampling intensity are decision
39
+ variables priced by their expected value of information, and observations recalibrate the growth
40
+ model.
41
+ - **Search the trade-offs.** A `fresh-solutions` problem adapter supplies exact evaluation, moves, and
42
+ undo; the engine supplies local search, population search, checkpoints, seeds, telemetry, and exact
43
+ replay. A Pareto archive keeps the cost, risk, service, and uncertainty trade-offs.
44
+ - **Compare owner and contractor views.** A plan carries a line-item cost build-up, assumptions,
45
+ quantities, rates, and provenance. A bid is an annotated plan, not a separate spreadsheet.
46
+ - **Explore it in a planning studio.** One optional FastAPI service and one static browser shell read
47
+ the run artifacts. MapLibre carries the 2D corridor map, Three.js carries the 3D operations scene,
48
+ and checked skins cover owner-strategic, tactical, operations, contractor, monitoring, and reviewer
49
+ roles. The studio animates deployment and explores the Pareto front without owning model state.
50
+
51
+ ## Status
52
+
53
+ Phase 0 (bootstrap and scope) and Phase 1 (contracts and prototype) are complete and merged. Phase 2
54
+ (FEMIC-extended instance builder) is active: the repository is pinning the FEMIC provider surface and
55
+ building the map-to-instance workflow on top of it. It does not yet have a usable vegetation model or
56
+ planner. `ROADMAP.md` is the plan of record, and the GitHub issues carry the live status.
57
+
58
+ Brushline is a working name. It is easy to rename before the first public release.
59
+
60
+ ## Quick start
61
+
62
+ ```bash
63
+ python -m venv .venv
64
+ . .venv/bin/activate
65
+ python -m pip install -r requirements-dev.txt
66
+ python -m pip install -e .
67
+ brushline --help
68
+ python scripts/dashboard.py
69
+ ```
70
+
71
+ The dashboard runs lint, format, strict types, tests with a coverage gate, the workflow validator, the
72
+ docs build, and the docstring audit. Every commit leaves it green.
73
+
74
+ ## How this project works
75
+
76
+ This project follows the UBC-FRESH dev workflow. Work is planned as phases, tasks, and subtasks in
77
+ `ROADMAP.md`, mirrored in GitHub issues, and recorded in `CHANGE_LOG.md`. The agent operating contract
78
+ is in `AGENTS.md`. Read `AGENTS.md`, then `ROADMAP.md`, before you change anything.
79
+
80
+ ## Repository map
81
+
82
+ | Path | Purpose |
83
+ | --- | --- |
84
+ | `AGENTS.md` | Operating contract for coding agents |
85
+ | `ROADMAP.md` | Plan of record and issue tracker map |
86
+ | `CHANGE_LOG.md` | Dated narrative of changes |
87
+ | `brushline/` | The Python package and command line |
88
+ | `docs/` | Documentation site, including the design index |
89
+ | `notes/design/` | Scope, architecture, optimization, and UI design records |
90
+ | `notes/adr/` | Architecture decisions |
91
+ | `notes/reports/` | Phase close-out reports |
92
+ | `scripts/check_workflow.py` | Workflow validator |
93
+ | `tests/` | pytest suite, including the planning-surface self-check |
94
+
95
+ ## Relationship to the other FRESH tools
96
+
97
+ Brushline is a sibling of WS4, FHOPS, the FRESH urban-forest lab, and Fresh Solutions. It borrows
98
+ patterns, not internals:
99
+
100
+ - **WS4** supplies the pattern for a compiled, inspectable dataset, spatial decisions inside the model,
101
+ artifact-based runs, and the web shell.
102
+ - **FHOPS** supplies the pattern for tactical and operational planning, machine and crew productivity,
103
+ and 3D operations visualization.
104
+ - **Fresh Solutions** supplies the metaheuristic engine and the exact replay contract.
105
+ - **The FRESH urban-forest lab** supplies the pattern for a 2D/3D browser studio with vendored,
106
+ offline-capable map and scene libraries.
107
+
108
+ The adapters are versioned and optional. Brushline stays installable without the other tools.
109
+
110
+ ## License
111
+
112
+ Apache-2.0. See [`LICENSE`](LICENSE) and [`CITATION.cff`](CITATION.cff).
@@ -0,0 +1,65 @@
1
+ # Brushline 0.1.0 release notes
2
+
3
+ Status: release candidate prepared; tag and GitHub release require maintainer approval.
4
+
5
+ ## What this is
6
+
7
+ Brushline is an open decision-support prototype for vegetation management along linear infrastructure
8
+ corridors. It provides a shared plan artifact, a strategic/tactical/operational planning stack, a
9
+ Pareto search adapter, a monitoring and replanning loop, a public demo portal, and a local planning
10
+ studio.
11
+
12
+ ## Changes
13
+
14
+ - P0-P2: identity, contracts, synthetic fixture, FEMIC-extended instance builder, catalogue, fetch
15
+ planning, capabilities, and model-builder prototype.
16
+ - P3: LiDAR bundle, terrain, canopy, state initialization, coverage, and sibling benchmark.
17
+ - P4: low-vegetation state space, growth, treatment transitions, calibration, hazards, held-out
18
+ validation, and model card.
19
+ - P5: formulation, exact evaluator, operators, Fresh Solutions adapter, Pareto archive, tiny-instance
20
+ validation, budget evidence, and studio telemetry.
21
+ - P6: strategic dynamic program, portfolio, monitoring policy, BAU, reports, scenario archive, and
22
+ synthetic validation.
23
+ - P7: tactical program, contractor resources, access, work orders, FHOPS dry-run boundary, timeline,
24
+ and validation.
25
+ - P8: observation, mission simulation, value of information, recalibration, replan trigger, and
26
+ adaptive-versus-calendar validation.
27
+ - P9: shared plan cost build-up, owner/contractor views, bid comparison, approval, and exchange
28
+ validation.
29
+ - P10: artifact-only planning studio with map, 3D context, forester POV walkthrough, pre/post
30
+ toggle, skins, Pareto, and timeline.
31
+ - P11: public synthetic demo portfolio, static portal, pilot brief, and validation.
32
+ - P12: 16-criterion verification, BAU case, monitoring value, exchange, performance limit, replay, and
33
+ release recommendation.
34
+
35
+ ## Known gaps
36
+
37
+ - No field calibration of shrub/young-tree growth or treatment response.
38
+ - No mature-forest EFI transfer validation.
39
+ - No live FEMIC/FreshForge build, live LiDAR campaign, live FHOPS run, or live road feed.
40
+ - The 10,000-segment/30-year/1,000-evaluation/8-core target is not demonstrated. P12 measures a small
41
+ case and reports the limit.
42
+ - The public demo is synthetic and static; the lab preview is not a production service.
43
+ - No authentication, production dispatch, safety certification, or engineering clearance claim.
44
+ - The 3D scene and POV walkthrough are context views; they are not survey-grade and invent no
45
+ positions.
46
+ - Monitoring value of information and budget/performance evidence use approximations and synthetic
47
+ assumptions.
48
+
49
+ ## Model and use boundaries
50
+
51
+ Use Brushline to structure evidence and compare transparent scenarios. Do not use it as the sole basis
52
+ for field treatment, contract award, safety clearance, or regulatory approval. Read the model card,
53
+ verification report, caveats, and known-gaps list before citing a result.
54
+
55
+ ## Publishing
56
+
57
+ - PyPI trusted publisher: project `brushline`, repository `UBC-FRESH/brushline`, workflow `release.yml`, environment `pypi`.
58
+ - TestPyPI trusted publisher: same project/repository/workflow, environment `testpypi`.
59
+ - A published GitHub release publishes the wheel and sdist to PyPI. A manual `Release` run publishes to TestPyPI.
60
+
61
+ ## Verification
62
+
63
+ - P12 verification report: `notes/reports/p12-verification.md`
64
+ - P12 close-out: `notes/reports/p12-closeout.md`
65
+ - License: Apache-2.0
@@ -0,0 +1,7 @@
1
+ """Brushline: decision support for vegetation management along linear corridors."""
2
+
3
+ from __future__ import annotations
4
+
5
+ __version__ = "0.1.0"
6
+
7
+ __all__ = ["__version__"]
@@ -0,0 +1,7 @@
1
+ """Build and compile paths for Brushline."""
2
+
3
+ from __future__ import annotations
4
+
5
+ from brushline.build.compiler import CompiledDataset, compile_fixture
6
+
7
+ __all__ = ["CompiledDataset", "compile_fixture"]