powercontract 0.1.0__tar.gz

powercontract-0.1.0/LICENSE

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

powercontract-0.1.0/PKG-INFO

@@ -0,0 +1,186 @@
+Metadata-Version: 2.4
+Name: powercontract
+Version: 0.1.0
+Summary: Validate oscilloscope captures against executable electrical requirements.
+Author: Sidelobe
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/sidelobe-labs/powercontract
+Project-URL: Repository, https://github.com/sidelobe-labs/powercontract
+Project-URL: Issues, https://github.com/sidelobe-labs/powercontract/issues
+Keywords: oscilloscope,hardware-validation,power-sequencing,embedded,electronics,requirements-as-code
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PyYAML<7,>=6.0
+Provides-Extra: dev
+Requires-Dist: build<2,>=1.2; extra == "dev"
+Requires-Dist: pytest<10,>=8; extra == "dev"
+Requires-Dist: twine<7,>=6; extra == "dev"
+Dynamic: license-file
+
+# PowerContract
+
+PowerContract evaluates oscilloscope waveform data against electrical requirements defined in YAML.
+
+For each requirement it reports `PASS`, `FAIL`, or `INDETERMINATE`, together with the measured value, limit, margin, and optional uncertainty and source.
+
+It does not control the oscilloscope or replace the vendor's waveform-analysis software. Acquisition and evaluation are separate.
+
+## Try it
+
+Install from a checkout:
+
+```bash
+python -m pip install .
+```
+
+Run the bundled example:
+
+```bash
+powercontract check examples/boot.csv examples/boot.yaml
+```
+
+Check the installed version:
+
+```bash
+powercontract --version
+```
+
+For your own capture, inspect the CSV first and use its actual column names in the contract. The [getting-started guide](docs/getting-started.md) walks through the full process.
+
+## Example contract
+
+```yaml
+version: 1
+
+capture:
+  time_column: Time
+
+signals:
+  vdd:
+    column: VDD_3V3
+    nominal: 3.3
+
+  en:
+    column: EN
+    nominal: 3.3
+
+events:
+  vdd_valid:
+    signal: vdd
+    direction: above
+    threshold: 3.0
+
+  en_release:
+    signal: en
+    direction: above
+    threshold: 2.0
+
+requirements:
+  - id: PWR-001
+    type: delay
+    from: vdd_valid
+    to: en_release
+    min: 50us
+    source: "Board power specification, section 3.2"
+
+  - id: PWR-002
+    type: max_value
+    signal: vdd
+    value: 3.6
+    uncertainty: 0.03
+```
+
+Run it with:
+
+```bash
+powercontract check capture.csv power.yaml
+```
+
+Write a JSON report with:
+
+```bash
+powercontract check capture.csv power.yaml --json report.json
+```
+
+## Requirements supported in v0.1
+
+Contract version 1 uses seconds for time and volts for signal values.
+
+
+- delay between named threshold events;
+- minimum and maximum voltage;
+- event-bounded voltage windows;
+- rise time and fall time;
+- threshold stability windows;
+- explicit measurement uncertainty;
+- optional requirement source;
+- terminal and JSON output.
+
+If the capture does not contain enough evidence to evaluate a requirement, the result is `INDETERMINATE`.
+
+## Capture formats
+
+| Input | Support |
+| --- | --- |
+| Normal table CSV with one time column and named signal columns | Supported |
+| Siglent SDS800X HD per-channel CSV | Tested with a real SDS824X HD |
+| Older Siglent / WaveAce-style `Source` + units CSV | Parser tested against documented/public examples |
+| Rigol sequence CSV with `Start` / `Increment` | Parser tested against public format examples |
+| Rigol paired XY CSV | Parser tested against public format examples |
+| Tektronix five-column CSV | Parser tested against the Tektronix-documented layout |
+| Keysight InfiniiVision multi-channel CSV | Supported through the normal table CSV loader when the file contains named columns |
+| CSV from Python, pandas, MATLAB, LabVIEW, or custom acquisition code | Supported through the normal table CSV loader |
+
+Only the Siglent SDS800X HD per-channel path is currently tested on physical hardware in this project. Other vendor-specific rows describe file-format support, not blanket support for every model from that vendor.
+
+See [Input formats](docs/input-formats.md) and [Oscilloscope vendor notes](docs/vendors.md) for details.
+
+## Documentation
+
+- [Getting started](docs/getting-started.md)
+- [Writing contracts](docs/contracts.md)
+- [Input formats](docs/input-formats.md)
+- [Oscilloscope vendor notes](docs/vendors.md)
+- [CI usage](docs/ci.md)
+- [Troubleshooting](docs/troubleshooting.md)
+
+## Exit codes
+
+| Code | Meaning |
+| ---: | --- |
+| `0` | all requirements passed |
+| `1` | at least one requirement failed or was indeterminate |
+| `2` | invalid capture, contract, or output request |
+
+## Scope
+
+PowerContract answers one question: did the measured signals satisfy the declared electrical requirements?
+
+It is not a waveform viewer, protocol decoder, SCPI control framework, automatic datasheet parser, or golden-waveform comparison tool.
+
+## Development
+
+```bash
+python -m pip install -e '.[dev]'
+pytest
+```
+
+CI runs the test suite on Python 3.11 and 3.12, builds the package, runs `twine check`, and installs the built wheel in a clean virtual environment.
+
+## License
+
+MIT. See [LICENSE](LICENSE).
+
+Release history is in [CHANGELOG.md](CHANGELOG.md).

powercontract-0.1.0/README.md

@@ -0,0 +1,155 @@
+# PowerContract
+
+PowerContract evaluates oscilloscope waveform data against electrical requirements defined in YAML.
+
+For each requirement it reports `PASS`, `FAIL`, or `INDETERMINATE`, together with the measured value, limit, margin, and optional uncertainty and source.
+
+It does not control the oscilloscope or replace the vendor's waveform-analysis software. Acquisition and evaluation are separate.
+
+## Try it
+
+Install from a checkout:
+
+```bash
+python -m pip install .
+```
+
+Run the bundled example:
+
+```bash
+powercontract check examples/boot.csv examples/boot.yaml
+```
+
+Check the installed version:
+
+```bash
+powercontract --version
+```
+
+For your own capture, inspect the CSV first and use its actual column names in the contract. The [getting-started guide](docs/getting-started.md) walks through the full process.
+
+## Example contract
+
+```yaml
+version: 1
+
+capture:
+  time_column: Time
+
+signals:
+  vdd:
+    column: VDD_3V3
+    nominal: 3.3
+
+  en:
+    column: EN
+    nominal: 3.3
+
+events:
+  vdd_valid:
+    signal: vdd
+    direction: above
+    threshold: 3.0
+
+  en_release:
+    signal: en
+    direction: above
+    threshold: 2.0
+
+requirements:
+  - id: PWR-001
+    type: delay
+    from: vdd_valid
+    to: en_release
+    min: 50us
+    source: "Board power specification, section 3.2"
+
+  - id: PWR-002
+    type: max_value
+    signal: vdd
+    value: 3.6
+    uncertainty: 0.03
+```
+
+Run it with:
+
+```bash
+powercontract check capture.csv power.yaml
+```
+
+Write a JSON report with:
+
+```bash
+powercontract check capture.csv power.yaml --json report.json
+```
+
+## Requirements supported in v0.1
+
+Contract version 1 uses seconds for time and volts for signal values.
+
+
+- delay between named threshold events;
+- minimum and maximum voltage;
+- event-bounded voltage windows;
+- rise time and fall time;
+- threshold stability windows;
+- explicit measurement uncertainty;
+- optional requirement source;
+- terminal and JSON output.
+
+If the capture does not contain enough evidence to evaluate a requirement, the result is `INDETERMINATE`.
+
+## Capture formats
+
+| Input | Support |
+| --- | --- |
+| Normal table CSV with one time column and named signal columns | Supported |
+| Siglent SDS800X HD per-channel CSV | Tested with a real SDS824X HD |
+| Older Siglent / WaveAce-style `Source` + units CSV | Parser tested against documented/public examples |
+| Rigol sequence CSV with `Start` / `Increment` | Parser tested against public format examples |
+| Rigol paired XY CSV | Parser tested against public format examples |
+| Tektronix five-column CSV | Parser tested against the Tektronix-documented layout |
+| Keysight InfiniiVision multi-channel CSV | Supported through the normal table CSV loader when the file contains named columns |
+| CSV from Python, pandas, MATLAB, LabVIEW, or custom acquisition code | Supported through the normal table CSV loader |
+
+Only the Siglent SDS800X HD per-channel path is currently tested on physical hardware in this project. Other vendor-specific rows describe file-format support, not blanket support for every model from that vendor.
+
+See [Input formats](docs/input-formats.md) and [Oscilloscope vendor notes](docs/vendors.md) for details.
+
+## Documentation
+
+- [Getting started](docs/getting-started.md)
+- [Writing contracts](docs/contracts.md)
+- [Input formats](docs/input-formats.md)
+- [Oscilloscope vendor notes](docs/vendors.md)
+- [CI usage](docs/ci.md)
+- [Troubleshooting](docs/troubleshooting.md)
+
+## Exit codes
+
+| Code | Meaning |
+| ---: | --- |
+| `0` | all requirements passed |
+| `1` | at least one requirement failed or was indeterminate |
+| `2` | invalid capture, contract, or output request |
+
+## Scope
+
+PowerContract answers one question: did the measured signals satisfy the declared electrical requirements?
+
+It is not a waveform viewer, protocol decoder, SCPI control framework, automatic datasheet parser, or golden-waveform comparison tool.
+
+## Development
+
+```bash
+python -m pip install -e '.[dev]'
+pytest
+```
+
+CI runs the test suite on Python 3.11 and 3.12, builds the package, runs `twine check`, and installs the built wheel in a clean virtual environment.
+
+## License
+
+MIT. See [LICENSE](LICENSE).
+
+Release history is in [CHANGELOG.md](CHANGELOG.md).

powercontract-0.1.0/pyproject.toml

@@ -0,0 +1,60 @@
+[build-system]
+requires = ["setuptools>=77.0.3"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "powercontract"
+dynamic = ["version"]
+description = "Validate oscilloscope captures against executable electrical requirements."
+readme = "README.md"
+requires-python = ">=3.11"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "Sidelobe" }]
+keywords = [
+  "oscilloscope",
+  "hardware-validation",
+  "power-sequencing",
+  "embedded",
+  "electronics",
+  "requirements-as-code",
+]
+dependencies = ["PyYAML>=6.0,<7"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Environment :: Console",
+  "Intended Audience :: Developers",
+  "Intended Audience :: Science/Research",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)",
+  "Topic :: Software Development :: Testing",
+]
+
+[project.urls]
+Homepage = "https://github.com/sidelobe-labs/powercontract"
+Repository = "https://github.com/sidelobe-labs/powercontract"
+Issues = "https://github.com/sidelobe-labs/powercontract/issues"
+
+[project.scripts]
+powercontract = "powercontract.cli:main"
+
+[project.optional-dependencies]
+dev = [
+  "build>=1.2,<2",
+  "pytest>=8,<10",
+  "twine>=6,<7",
+]
+
+[tool.setuptools.dynamic]
+version = { attr = "powercontract.__version__" }
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+addopts = "-q"
+testpaths = ["tests"]

powercontract-0.1.0/setup.cfg

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

powercontract-0.1.0/src/powercontract/__init__.py

@@ -0,0 +1,3 @@
+"""PowerContract public package."""
+
+__version__ = "0.1.0"