aei-workflow-runner 0.1.0__tar.gz

aei_workflow_runner-0.1.0/LICENSE

@@ -0,0 +1,204 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the
+      purposes of this License, Derivative Works shall not include works
+      that remain separable from, or merely link (or bind by name) to the
+      interfaces of, the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including the
+      original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright
+      owner or by an individual or Legal Entity authorized to submit on
+      behalf of the copyright owner. For the purposes of this definition,
+      "submitted" means any form of electronic, verbal, or written
+      communication sent to the Licensor or its representatives,
+      including but not limited to communication on electronic mailing
+      lists, source code control systems, and issue tracking systems that
+      are managed by, or on behalf of, the Licensor for the purpose of
+      discussing and improving the Work, but excluding communication that
+      is conspicuously marked or otherwise designated in writing by the
+      copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have
+      made, use, offer to sell, sell, import, and otherwise transfer the
+      Work, where such license applies only to those patent claims
+      licensable by such Contributor that are necessarily infringed by
+      their Contribution(s) alone or by combination of their
+      Contribution(s) with the Work to which such Contribution(s) was
+      submitted. If You institute patent litigation against any entity
+      (including a cross-claim or counterclaim in a lawsuit) alleging
+      that the Work or a Contribution incorporated within the Work
+      constitutes direct or contributory patent infringement, then any
+      patent licenses granted to You under this License for that Work
+      shall terminate as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing
+      the origin of the Work and reproducing the content of the NOTICE
+      file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or
+      conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS
+      FOR A PARTICULAR PURPOSE. You are solely responsible for
+      determining the appropriateness of using or redistributing the
+      Work and assume any risks associated with Your exercise of
+      permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 AID Edge Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

aei_workflow_runner-0.1.0/PKG-INFO

@@ -0,0 +1,133 @@
+Metadata-Version: 2.4
+Name: aei-workflow-runner
+Version: 0.1.0
+Summary: Local-first workflow runner for Velorona: validated link workflows, per-link Path Clearance runs, crash-safe run history, comparison, evidence export, and a scheduler-friendly CLI. Shared by Velorona Web and the Velorona QGIS plugin.
+Author: AID Edge Inc.
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/AIDEdgeInc-Lab/aei-workflow-runner
+Project-URL: Repository, https://github.com/AIDEdgeInc-Lab/aei-workflow-runner
+Project-URL: Issues, https://github.com/AIDEdgeInc-Lab/aei-workflow-runner/issues
+Keywords: microwave,path-clearance,workflow,scheduler,local-first
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Telecommunications Industry
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aei-link-clearance[elevation]>=0.1.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Dynamic: license-file
+
+# aei-workflow-runner
+
+The product-neutral core of Velorona's workflow automation, plus a headless CLI, `velorona-run`, for **unattended local
+runs started by your own operating-system scheduler**.
+
+* **Shared by two independent products.** The Velorona QGIS plugin uses this package as a library. Velorona Web (the browser Map)
+  cannot run Python, so it implements the same versioned documents in JavaScript and is held to them by tests. Neither product
+  needs the other, and neither needs this CLI to work.
+* **Local-first.** Everything is written to a folder you choose. No AID Edge server, account, database, cloud service or
+  telemetry is involved, and none is required.
+* **Scope today: terrestrial Path Clearance** on your own link list (CSV). It is read-only analysis and decision support. It does
+  **not** poll SNMP, ingest operator telemetry, predict outages, or change any network equipment.
+
+Status: 0.1.0, first public release (alpha). It is offered as-is under the Apache License 2.0; see the limitations below for what has and has not been tested.
+
+## What it is not (read this first)
+
+* **Not a monitoring system.** A scheduled run re-analyses your link list against terrain data. Repeated runs give you a history of
+  *analysis results*, not telemetry samples over time, and not a replay of past conditions (terrain is a static model).
+* **Not an always-on service.** It runs when your OS scheduler starts it. If the computer is off or asleep, nothing runs; the next
+  run records that occurrence as **missed** (it never pretends it ran). Use an always-on machine or server for overnight jobs.
+* **Not a bundled data source.** Every link analysis asks the Open-Meteo elevation service for terrain. **Open-Meteo's free tier
+  is for non-commercial use only** (its terms: fewer than 10,000 calls/day, 5,000/hour, 600/minute, CC-BY 4.0 attribution;
+  checked 2026-09-26 at open-meteo.com/en/terms). A commercial operator needs its own Open-Meteo commercial subscription and
+  pays for it directly. This package has **no API-key or alternative-provider support yet** (NOT IMPLEMENTED), so a commercial
+  plan cannot be used through it today.
+
+## Install
+
+```sh
+python3 -m pip install aei-workflow-runner        # Python 3.9+; installs aei-link-clearance[elevation] and its dependencies
+velorona-run --version
+```
+
+For development: `python3 -m pip install -e ".[dev]"` from a clone of this repository, then `pytest`.
+
+Tested with Python 3.9.6 and 3.12.11 on macOS (Apple silicon). Linux is expected to work (POSIX code paths, cron/systemd
+templates) but was **not tested by the maintainers**. Windows is **not supported** in this release: lock-liveness checks and Task
+Scheduler setup were not implemented or tested.
+
+## Verified local run
+
+```sh
+export VELORONA_STORE="$HOME/velorona-data"          # YOUR folder; there is deliberately no default location
+velorona-run init --name "Nightly check" --links "$HOME/links/latest.csv" --out nightly.json
+velorona-run validate nightly.json                    # checks the workflow and the CSV, runs nothing
+velorona-run install nightly.json                     # puts it in the store
+velorona-run run --workflow-id <id printed by init>   # one manual run
+velorona-run status                                   # last run, errors, next due, lock state
+```
+
+`--links` may be a CSV file, or a folder (the newest `*.csv` in it is used each run, so a nightly export dropped in that folder
+is picked up automatically). Required CSV columns are exactly those of `aei_link_clearance.batch`:
+`link_id, site_a_lat, site_a_lon, site_a_height_m, site_b_lat, site_b_lon, site_b_height_m, frequency_ghz`.
+
+## Verified recurring run (via your OS scheduler)
+
+See `docs/SCHEDULING.md`. In short: give the workflow a schedule when you create it
+(`--daily 02:00 --timezone America/Toronto`), install it, and have cron / launchd / systemd run `velorona-run tick` every 5
+minutes. `velorona-run schedule-template --kind launchd|cron|systemd --store DIR` prints ready-to-use text; it installs nothing.
+Verified end to end on macOS with launchd (see the handoff).
+
+## Where things are stored
+
+```
+<store>/workflows/<id>.json              workflow definitions (older versions kept in workflows/_history/)
+<store>/runs/<run_id>/run.json           the immutable-in-practice record of each run (also missed occurrences)
+<store>/runs/<run_id>/evidence/          report.md, results.csv, links.geojson, input_links.csv, run.json, manifest.json (SHA-256)
+<store>/_pruned/<run_id>/                runs moved aside by YOUR retention settings (never deleted by this program)
+<store>/logs/<workflow_id>.jsonl         structured log: ids, statuses, counts, timings only (no link ids, coordinates, paths, errors)
+<store>/locks/, <store>/schedule/        one-run-at-a-time lock; scheduler state
+```
+
+Writes are atomic (temp file, fsync, rename). Nothing is overwritten silently: a new run has a new id, an existing workflow
+needs `--replace` and a higher `workflow_version`, backups and exports refuse to overwrite an existing file or folder.
+
+## Retention
+
+Set by you per workflow: `--retain-runs N` (keep the newest N) and/or `--retain-hours H` (keep runs finished in the last H hours,
+e.g. 1, 2, 10, 24, or 720). With neither, **everything is kept**. Runs outside your window are *moved* to `_pruned/`, together with
+their evidence; this program never deletes them. Delete `_pruned/` yourself when you decide to. Logs are not rotated or removed.
+
+## What leaves your machine
+
+Only the terrain request, per link: `GET https://api.open-meteo.com/v1/elevation?latitude=<50 values>&longitude=<50 values>`,
+the coordinates of 50 points along the straight path between the two endpoints. Not sent: link IDs, antenna heights, frequencies,
+file names, workflow names, CSV contents, run results. The request goes directly from your machine to Open-Meteo (they see your IP
+address and what any HTTP client sends); Velorona does not control how they log or keep it. Nothing is sent to AID Edge.
+The test suite checks that the runner opens no other network connection (every socket connect is an error in the CLI tests).
+
+## Backup, restore, interoperability
+
+`velorona-run backup --out FILE.zip` / `restore FILE.zip` use the same zip layout as the QGIS plugin and Velorona Web
+(`docs/CONTRACT.md`): a backup from any of the three restores in the other two, tested in both directions. Restore never
+overwrites an existing record and validates every file (schema version, checksum, names). `import-doc` imports a single
+`run.json` or workflow file. Browser-local storage (IndexedDB) and this folder are different storage systems: nothing syncs
+between them; you move data explicitly with backup/restore.
+
+## Known limitations
+
+* Cancel (Ctrl-C / SIGTERM) takes effect between links; a request in flight finishes first (15 s timeout).
+* A crash or `kill -9` leaves the run `running` on disk, with finished links saved (checkpoint at most every 2 s). The next run of
+  that workflow, or `status`/QGIS opening the store, relabels it `interrupted`.
+* Lock liveness uses the process id on the same host; a lock from another host or an unreadable lock is treated as held and needs
+  `velorona-run unlock --workflow-id ID --force`. A store on a network share is not recommended.
+* Retry is a fixed delay, not adaptive back-off; use `--pause-seconds` to stay under a provider's rate limit.
+* Only `.csv` inputs up to 50 MB are read, whatever a workflow file says.

aei_workflow_runner-0.1.0/README.md

@@ -0,0 +1,107 @@
+# aei-workflow-runner
+
+The product-neutral core of Velorona's workflow automation, plus a headless CLI, `velorona-run`, for **unattended local
+runs started by your own operating-system scheduler**.
+
+* **Shared by two independent products.** The Velorona QGIS plugin uses this package as a library. Velorona Web (the browser Map)
+  cannot run Python, so it implements the same versioned documents in JavaScript and is held to them by tests. Neither product
+  needs the other, and neither needs this CLI to work.
+* **Local-first.** Everything is written to a folder you choose. No AID Edge server, account, database, cloud service or
+  telemetry is involved, and none is required.
+* **Scope today: terrestrial Path Clearance** on your own link list (CSV). It is read-only analysis and decision support. It does
+  **not** poll SNMP, ingest operator telemetry, predict outages, or change any network equipment.
+
+Status: 0.1.0, first public release (alpha). It is offered as-is under the Apache License 2.0; see the limitations below for what has and has not been tested.
+
+## What it is not (read this first)
+
+* **Not a monitoring system.** A scheduled run re-analyses your link list against terrain data. Repeated runs give you a history of
+  *analysis results*, not telemetry samples over time, and not a replay of past conditions (terrain is a static model).
+* **Not an always-on service.** It runs when your OS scheduler starts it. If the computer is off or asleep, nothing runs; the next
+  run records that occurrence as **missed** (it never pretends it ran). Use an always-on machine or server for overnight jobs.
+* **Not a bundled data source.** Every link analysis asks the Open-Meteo elevation service for terrain. **Open-Meteo's free tier
+  is for non-commercial use only** (its terms: fewer than 10,000 calls/day, 5,000/hour, 600/minute, CC-BY 4.0 attribution;
+  checked 2026-09-26 at open-meteo.com/en/terms). A commercial operator needs its own Open-Meteo commercial subscription and
+  pays for it directly. This package has **no API-key or alternative-provider support yet** (NOT IMPLEMENTED), so a commercial
+  plan cannot be used through it today.
+
+## Install
+
+```sh
+python3 -m pip install aei-workflow-runner        # Python 3.9+; installs aei-link-clearance[elevation] and its dependencies
+velorona-run --version
+```
+
+For development: `python3 -m pip install -e ".[dev]"` from a clone of this repository, then `pytest`.
+
+Tested with Python 3.9.6 and 3.12.11 on macOS (Apple silicon). Linux is expected to work (POSIX code paths, cron/systemd
+templates) but was **not tested by the maintainers**. Windows is **not supported** in this release: lock-liveness checks and Task
+Scheduler setup were not implemented or tested.
+
+## Verified local run
+
+```sh
+export VELORONA_STORE="$HOME/velorona-data"          # YOUR folder; there is deliberately no default location
+velorona-run init --name "Nightly check" --links "$HOME/links/latest.csv" --out nightly.json
+velorona-run validate nightly.json                    # checks the workflow and the CSV, runs nothing
+velorona-run install nightly.json                     # puts it in the store
+velorona-run run --workflow-id <id printed by init>   # one manual run
+velorona-run status                                   # last run, errors, next due, lock state
+```
+
+`--links` may be a CSV file, or a folder (the newest `*.csv` in it is used each run, so a nightly export dropped in that folder
+is picked up automatically). Required CSV columns are exactly those of `aei_link_clearance.batch`:
+`link_id, site_a_lat, site_a_lon, site_a_height_m, site_b_lat, site_b_lon, site_b_height_m, frequency_ghz`.
+
+## Verified recurring run (via your OS scheduler)
+
+See `docs/SCHEDULING.md`. In short: give the workflow a schedule when you create it
+(`--daily 02:00 --timezone America/Toronto`), install it, and have cron / launchd / systemd run `velorona-run tick` every 5
+minutes. `velorona-run schedule-template --kind launchd|cron|systemd --store DIR` prints ready-to-use text; it installs nothing.
+Verified end to end on macOS with launchd (see the handoff).
+
+## Where things are stored
+
+```
+<store>/workflows/<id>.json              workflow definitions (older versions kept in workflows/_history/)
+<store>/runs/<run_id>/run.json           the immutable-in-practice record of each run (also missed occurrences)
+<store>/runs/<run_id>/evidence/          report.md, results.csv, links.geojson, input_links.csv, run.json, manifest.json (SHA-256)
+<store>/_pruned/<run_id>/                runs moved aside by YOUR retention settings (never deleted by this program)
+<store>/logs/<workflow_id>.jsonl         structured log: ids, statuses, counts, timings only (no link ids, coordinates, paths, errors)
+<store>/locks/, <store>/schedule/        one-run-at-a-time lock; scheduler state
+```
+
+Writes are atomic (temp file, fsync, rename). Nothing is overwritten silently: a new run has a new id, an existing workflow
+needs `--replace` and a higher `workflow_version`, backups and exports refuse to overwrite an existing file or folder.
+
+## Retention
+
+Set by you per workflow: `--retain-runs N` (keep the newest N) and/or `--retain-hours H` (keep runs finished in the last H hours,
+e.g. 1, 2, 10, 24, or 720). With neither, **everything is kept**. Runs outside your window are *moved* to `_pruned/`, together with
+their evidence; this program never deletes them. Delete `_pruned/` yourself when you decide to. Logs are not rotated or removed.
+
+## What leaves your machine
+
+Only the terrain request, per link: `GET https://api.open-meteo.com/v1/elevation?latitude=<50 values>&longitude=<50 values>`,
+the coordinates of 50 points along the straight path between the two endpoints. Not sent: link IDs, antenna heights, frequencies,
+file names, workflow names, CSV contents, run results. The request goes directly from your machine to Open-Meteo (they see your IP
+address and what any HTTP client sends); Velorona does not control how they log or keep it. Nothing is sent to AID Edge.
+The test suite checks that the runner opens no other network connection (every socket connect is an error in the CLI tests).
+
+## Backup, restore, interoperability
+
+`velorona-run backup --out FILE.zip` / `restore FILE.zip` use the same zip layout as the QGIS plugin and Velorona Web
+(`docs/CONTRACT.md`): a backup from any of the three restores in the other two, tested in both directions. Restore never
+overwrites an existing record and validates every file (schema version, checksum, names). `import-doc` imports a single
+`run.json` or workflow file. Browser-local storage (IndexedDB) and this folder are different storage systems: nothing syncs
+between them; you move data explicitly with backup/restore.
+
+## Known limitations
+
+* Cancel (Ctrl-C / SIGTERM) takes effect between links; a request in flight finishes first (15 s timeout).
+* A crash or `kill -9` leaves the run `running` on disk, with finished links saved (checkpoint at most every 2 s). The next run of
+  that workflow, or `status`/QGIS opening the store, relabels it `interrupted`.
+* Lock liveness uses the process id on the same host; a lock from another host or an unreadable lock is treated as held and needs
+  `velorona-run unlock --workflow-id ID --force`. A store on a network share is not recommended.
+* Retry is a fixed delay, not adaptive back-off; use `--pause-seconds` to stay under a provider's rate limit.
+* Only `.csv` inputs up to 50 MB are read, whatever a workflow file says.

aei_workflow_runner-0.1.0/pyproject.toml

@@ -0,0 +1,45 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "aei-workflow-runner"
+version = "0.1.0"
+description = "Local-first workflow runner for Velorona: validated link workflows, per-link Path Clearance runs, crash-safe run history, comparison, evidence export, and a scheduler-friendly CLI. Shared by Velorona Web and the Velorona QGIS plugin."
+readme = "README.md"
+requires-python = ">=3.9"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [{ name = "AID Edge Inc." }]
+keywords = ["microwave", "path-clearance", "workflow", "scheduler", "local-first"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Telecommunications Industry",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Scientific/Engineering",
+]
+# The analysis itself stays in aei-link-clearance (unmodified); this package only orchestrates, validates, stores and reports.
+# "elevation" brings `requests`, which the terrain lookup needs. Nothing else: no server, no database, no account.
+dependencies = ["aei-link-clearance[elevation]>=0.1.0"]
+
+[project.urls]
+Homepage = "https://github.com/AIDEdgeInc-Lab/aei-workflow-runner"
+Repository = "https://github.com/AIDEdgeInc-Lab/aei-workflow-runner"
+Issues = "https://github.com/AIDEdgeInc-Lab/aei-workflow-runner/issues"
+
+[project.optional-dependencies]
+dev = ["pytest>=7.0"]
+
+[project.scripts]
+velorona-run = "aei_workflow.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+pythonpath = ["src", "tests"]
+testpaths = ["tests"]

aei_workflow_runner-0.1.0/setup.cfg

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

aei_workflow_runner-0.1.0/src/aei_workflow/__init__.py

@@ -0,0 +1,4 @@
+"""aei_workflow: the product-neutral core shared by Velorona Web (as a documented contract) and the Velorona QGIS plugin
+(as a library), plus the headless `velorona-run` CLI. No UI, no QGIS, no browser code lives here."""
+
+__version__ = "0.1.0"

aei_workflow_runner-0.1.0/src/aei_workflow/__main__.py

@@ -0,0 +1,5 @@
+import sys
+
+from .cli import main
+
+sys.exit(main())

aei_workflow_runner-0.1.0/src/aei_workflow/bounds.py

@@ -0,0 +1,46 @@
+"""Terrestrial Path Clearance input bounds and their stated basis -- the single source of truth.
+
+Product-neutral: no QGIS, no browser. The QGIS plugin builds its parameter dialog from this list, the runner
+validates every input row against it, and the Web Map's evidence.js TERRESTRIAL_BOUNDS is held equal to it by
+tests/test_bounds_contract.py (against contract/terrestrial_bounds.json) and by the Map repo's own copy of that file.
+
+An out-of-range value is refused, never clamped.
+"""
+
+# Bounds carry their own basis, because an out-of-range value is accepted,
+# computed and exported typed "Calculated" -- a physically meaningless number
+# wearing the same authority as a real one. Each "basis" below says where the
+# limit comes from; where no citable source exists it says so explicitly
+# rather than presenting an engineering judgment as derived.
+TERRESTRIAL_PARAM_SPEC = [
+    {"key": "site_a_height_m", "label": "Site A antenna height", "type": "float",
+     "default": 30.0, "suffix": " m", "min": 0.1, "max": 1000.0,
+     "basis": "Conservative engineering limit, not a derived bound: no library or "
+              "standard constrains antenna height. 1000 m clears the CN Tower (553 m) "
+              "and the tallest guyed mast (~628 m) with margin."},
+    {"key": "site_b_height_m", "label": "Site B antenna height", "type": "float",
+     "default": 30.0, "suffix": " m", "min": 0.1, "max": 1000.0,
+     "basis": "Conservative engineering limit, not a derived bound: no library or "
+              "standard constrains antenna height. 1000 m clears the CN Tower (553 m) "
+              "and the tallest guyed mast (~628 m) with margin."},
+    {"key": "frequency_ghz", "label": "Frequency", "type": "float",
+     "default": 7.0, "suffix": " GHz", "min": 0.1, "max": 100.0,
+     "basis": "Lower bound derived: aei_link_clearance.fresnel.fresnel_radius_m and "
+              "terrain.py both raise ValueError for a non-positive frequency. The "
+              "0.1-100 GHz envelope is a conservative engineering limit, not a model "
+              "range -- Fresnel geometry has no frequency ceiling. It brackets the "
+              "loaded ISED Fixed Service data (915.1 MHz to 85.75 GHz) so it cannot "
+              "exclude a real record."},
+]
+
+
+def bounds() -> dict:
+    """{key: (min, max)} for every bounded parameter."""
+    return {p["key"]: (p["min"], p["max"]) for p in TERRESTRIAL_PARAM_SPEC if "min" in p}
+
+
+def contract() -> dict:
+    """The machine-readable form written to contract/terrestrial_bounds.json (labels and units, no prose)."""
+    return {"schema": "velorona.terrestrial-bounds", "version": 1,
+            "bounds": {p["key"]: {"min": p["min"], "max": p["max"], "label": p["label"], "suffix": p.get("suffix", "").strip()}
+                       for p in TERRESTRIAL_PARAM_SPEC if "min" in p}}