rfmeasurement 0.1.0__tar.gz

rfmeasurement-0.1.0/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,36 @@
+name: Bug report
+description: Report incorrect or unexpected behavior in rfmeasurement.
+labels: ["bug"]
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: What happened, and what did you expect instead?
+    validations:
+      required: true
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Minimal reproducible example
+      description: A minimal, self-contained code snippet that reproduces the issue.
+      render: python
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: rfmeasurement version
+    validations:
+      required: true
+  - type: input
+    id: python-version
+    attributes:
+      label: Python version
+    validations:
+      required: true
+  - type: textarea
+    id: environment
+    attributes:
+      label: Environment
+      description: OS, relevant dependency versions (scikit-rf, numpy, ...).

rfmeasurement-0.1.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Discussions
+    url: https://github.com/telmomm/rfmeasurement/discussions
+    about: Architectural questions, proposed scientific directions, and roadmap proposals.

rfmeasurement-0.1.0/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,27 @@
+name: Feature request
+description: Propose new functionality for rfmeasurement.
+labels: ["enhancement"]
+body:
+  - type: textarea
+    id: motivation
+    attributes:
+      label: Motivation
+      description: What problem does this solve? Reference docs/scope.md if relevant.
+    validations:
+      required: true
+  - type: textarea
+    id: proposal
+    attributes:
+      label: Proposed solution
+    validations:
+      required: true
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives considered
+  - type: checkboxes
+    id: scope-check
+    attributes:
+      label: Scope
+      options:
+        - label: I have checked docs/scope.md and believe this is in scope for the core package.

rfmeasurement-0.1.0/.github/ISSUE_TEMPLATE/scientific_question.yml

@@ -0,0 +1,22 @@
+name: Scientific question or concern
+description: Question about a validation rule, uncertainty method, or scientific assumption.
+labels: ["scientific-review"]
+body:
+  - type: textarea
+    id: topic
+    attributes:
+      label: Method or module in question
+      description: Which validation rule, uncertainty model, or algorithm does this concern?
+    validations:
+      required: true
+  - type: textarea
+    id: concern
+    attributes:
+      label: Question or concern
+    validations:
+      required: true
+  - type: textarea
+    id: references
+    attributes:
+      label: References
+      description: Standards, papers, or textbooks relevant to this question.

rfmeasurement-0.1.0/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

rfmeasurement-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,82 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  test:
+    name: test (py${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install package
+        run: python -m pip install -e ".[dev]"
+
+      - name: Lint
+        run: ruff check .
+
+      - name: Type check
+        run: mypy src/rfmeasurement
+
+      - name: Run tests
+        run: pytest --cov=rfmeasurement --cov-report=term-missing
+
+  docs:
+    name: docs-check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Check for broken relative links in docs
+        run: |
+          python - <<'EOF'
+          import pathlib
+          import re
+          import sys
+
+          root = pathlib.Path(".")
+          docs = list(root.glob("docs/**/*.md")) + [root / "README.md"]
+          link_re = re.compile(r"\]\(([^)]+)\)")
+          missing = []
+          for doc in docs:
+              text = doc.read_text(encoding="utf-8")
+              for target in link_re.findall(text):
+                  if target.startswith(("http://", "https://", "#", "mailto:")):
+                      continue
+                  target_path = (doc.parent / target.split("#")[0]).resolve()
+                  if not target_path.exists():
+                      missing.append(f"{doc}: {target}")
+          if missing:
+              print("Broken relative links found:")
+              for m in missing:
+                  print(f"  {m}")
+              sys.exit(1)
+          EOF
+
+  sphinx-docs:
+    name: sphinx-build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install package with docs extras
+        run: python -m pip install -e ".[docs]"
+
+      - name: Build Sphinx docs (warnings as errors)
+        run: sphinx-build -b html -W docs/sphinx docs/sphinx/_build/html

rfmeasurement-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,50 @@
+name: Release
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build sdist and wheel
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build backend
+        run: python -m pip install build
+
+      - name: Build distributions
+        run: python -m build
+
+      - name: Check distributions
+        run: python -m pip install twine && twine check dist/*
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/rfmeasurement/
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

rfmeasurement-0.1.0/.gitignore

@@ -0,0 +1,16 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+.venv/
+venv/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+.DS_Store
+docs/sphinx/_build/
+docs/sphinx/api/generated/

rfmeasurement-0.1.0/.readthedocs.yaml

@@ -0,0 +1,17 @@
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.12"
+
+sphinx:
+  configuration: docs/sphinx/conf.py
+  fail_on_warning: true
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

rfmeasurement-0.1.0/CHANGELOG.md

@@ -0,0 +1,46 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/)
+once a stable API is released.
+
+## [Unreleased]
+
+## [0.1.0] - 2026-08-22
+
+First tagged release. The public API is not yet stable (pre-1.0 semantic
+versioning): expect breaking changes in `0.x` releases. See
+[docs/roadmap.md](docs/roadmap.md) for what is and is not implemented yet --
+notably, there is no dedicated I/O/adapter layer, provenance persistence, or
+reporting output beyond the in-memory domain objects.
+
+### Added
+
+- **Project foundation** (Phase 0): BSD-3-Clause license, code of conduct,
+  contributing guide, issue templates, CI (tests, lint, type checks, docs
+  build), `src/` package layout, and initial Architecture Decision Records.
+- **Domain model** (Phase 1): `Measurement`, `MeasurementContext`,
+  `Measurand`, `ProvenanceRecord`, `AnalysisResult`, `ValidationResult` /
+  `ValidationReport`, and `UncertaintySource`, wrapping `skrf.Network` rather
+  than reimplementing RF network mathematics.
+- **Measurement-quality validation engine** (Phase 2): a composable
+  `ValidationRule` interface and seven rules (structural integrity, finite
+  values, frequency-grid consistency, passivity, reciprocity, continuity,
+  dynamic-range indicator), producing a structured `ValidationReport`.
+- **Uncertainty quantification engine** (Phase 3): `UncertaintyModel` and
+  `UncertaintyBudget` domain objects; Type A/B distribution sampling;
+  covariance-aware linear (GUM) propagation; Monte Carlo propagation with
+  correlated-normal sampling; ranked uncertainty budgets; and coverage
+  intervals (Gaussian and empirical).
+- Published documentation on Read the Docs
+  (<https://rfmeasurement.readthedocs.io/en/latest/>), built with Sphinx +
+  MyST from docstrings, alongside the project design specification in
+  `docs/`.
+- Two runnable examples: validating a synthetic measurement
+  (`examples/01_validate_measurement.py`) and propagating uncertainty
+  through a nonlinear dB conversion (`examples/02_propagate_uncertainty.py`).
+
+[Unreleased]: https://github.com/telmomm/rfmeasurement/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/telmomm/rfmeasurement/releases/tag/v0.1.0

rfmeasurement-0.1.0/CITATION.cff

@@ -0,0 +1,12 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+title: "rfmeasurement: an open-source framework for uncertainty-aware validation and reproducible analysis of RF measurements"
+type: software
+authors:
+  - family-names: "Miguel-Medina"
+    given-names: "Telmo"
+    orcid: "https://orcid.org/0009-0004-0654-6650"
+repository-code: "https://github.com/telmomm/rfmeasurement"
+license: BSD-3-Clause
+version: 0.1.0
+date-released: "2026-08-22"

rfmeasurement-0.1.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,64 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in
+our community a harassment-free experience for everyone, regardless of
+age, body size, visible or invisible disability, ethnicity, sex
+characteristics, gender identity and expression, level of experience,
+education, socio-economic status, nationality, personal appearance, race,
+religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open,
+welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment:
+
+- demonstrating empathy and kindness toward other people;
+- being respectful of differing opinions, viewpoints, and experiences;
+- giving and gracefully accepting constructive feedback;
+- accepting responsibility and apologizing for mistakes, and learning
+  from the experience;
+- focusing on what is best not just for us as individuals, but for the
+  overall community and the scientific integrity of the project.
+
+Examples of unacceptable behavior:
+
+- the use of sexualized language or imagery, and sexual attention or
+  advances of any kind;
+- trolling, insulting or derogatory comments, and personal or political
+  attacks;
+- public or private harassment;
+- publishing others' private information without explicit permission;
+- other conduct which could reasonably be considered inappropriate in a
+  professional setting.
+
+## Enforcement Responsibilities
+
+Project maintainers are responsible for clarifying and enforcing our
+standards of acceptable behavior and will take appropriate and fair
+corrective action in response to any behavior that they deem
+inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all community spaces (issues, pull
+requests, discussions) and also applies when an individual is officially
+representing the project in public spaces.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may
+be reported to the maintainers by opening a confidential issue or
+contacting them directly. All complaints will be reviewed and
+investigated promptly and fairly.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+<https://www.contributor-covenant.org/version/2/1/code_of_conduct.html>.
+
+[homepage]: https://www.contributor-covenant.org

rfmeasurement-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,74 @@
+# Contributing to rfmeasurement
+
+Thank you for considering a contribution. The project is developed in the
+open from its earliest stages; the full contribution philosophy is
+documented in [docs/contributing.md](docs/contributing.md) and the
+[governance model](docs/governance.md). This file gives the practical
+mechanics.
+
+## Getting started
+
+```bash
+git clone https://github.com/telmomm/rfmeasurement.git
+cd rfmeasurement
+python -m pip install -e ".[dev]"
+pytest
+```
+
+## Before opening a pull request
+
+1. Search existing issues to avoid duplicate work.
+2. Explain the motivation, ideally by referencing or opening an issue.
+3. Keep changes focused on a single concern.
+4. Add or update tests (see [docs/testing-validation.md](docs/testing-validation.md)
+   for the test pyramid: unit, integration, scientific, regression).
+5. Update documentation, including docstrings and relevant files under `docs/`.
+6. Describe any scientific assumptions made.
+7. Update `CHANGELOG.md` when the change is user-visible.
+
+## Scientific contributions
+
+A pull request implementing a scientific method (validation rule,
+uncertainty model, propagation algorithm, etc.) should additionally
+include:
+
+- references to the method (standard, paper, or textbook);
+- the mathematical definition;
+- assumptions and limitations;
+- a validation strategy (analytical reference, independently verified
+  example, or comparison with an established implementation);
+- comparison with existing implementations where possible.
+
+Experimental or heuristic algorithms must be clearly labeled as such and
+must not be presented as validated metrology methods without evidence.
+
+## API changes
+
+Public API changes should be discussed in an issue or discussion before
+implementation. Breaking changes require explicit justification and
+should be called out prominently in `CHANGELOG.md`.
+
+## Code review
+
+Reviewers assess correctness, tests, API clarity, documentation,
+numerical stability, scientific validity, and maintainability.
+
+## Code style
+
+- Format and lint with `ruff`.
+- Type-check with `mypy` where annotations are present.
+- Follow the `src/` layout described in
+  [docs/repository-organization.md](docs/repository-organization.md).
+
+## Reporting bugs and asking questions
+
+Use the GitHub issue templates for bug reports, feature requests, and
+scientific questions. A bug report should include a minimal reproducible
+example whenever possible. Use GitHub Discussions for open-ended
+architectural or scientific-direction questions.
+
+## Attribution
+
+Contributors receive appropriate credit. When a contribution is
+substantial to the scientific software, authorship or formal
+acknowledgement will be discussed transparently with the contributor.

rfmeasurement-0.1.0/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2026, rfmeasurement contributors
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

rfmeasurement-0.1.0/PKG-INFO

@@ -0,0 +1,154 @@
+Metadata-Version: 2.5
+Name: rfmeasurement
+Version: 0.1.0
+Summary: An open-source framework for uncertainty-aware validation and reproducible analysis of RF measurements.
+Project-URL: Homepage, https://github.com/telmomm/rfmeasurement
+Project-URL: Documentation, https://rfmeasurement.readthedocs.io/en/latest/
+Project-URL: Issues, https://github.com/telmomm/rfmeasurement/issues
+Project-URL: Changelog, https://github.com/telmomm/rfmeasurement/blob/main/CHANGELOG.md
+Author: rfmeasurement contributors
+License: BSD 3-Clause License
+        
+        Copyright (c) 2026, rfmeasurement contributors
+        
+        Redistribution and use in source and binary forms, with or without
+        modification, are permitted provided that the following conditions are met:
+        
+        1. Redistributions of source code must retain the above copyright notice, this
+           list of conditions and the following disclaimer.
+        
+        2. Redistributions in binary form must reproduce the above copyright notice,
+           this list of conditions and the following disclaimer in the documentation
+           and/or other materials provided with the distribution.
+        
+        3. Neither the name of the copyright holder nor the names of its
+           contributors may be used to endorse or promote products derived from
+           this software without specific prior written permission.
+        
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+        ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+        LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+        CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+        SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+        INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+        CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+        ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+        POSSIBILITY OF SUCH DAMAGE.
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.10
+Requires-Dist: numpy>=1.24
+Requires-Dist: scikit-rf>=1.0
+Provides-Extra: dev
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: myst-parser>=2.0; extra == 'docs'
+Requires-Dist: sphinx-rtd-theme>=2.0; extra == 'docs'
+Requires-Dist: sphinx>=7.0; extra == 'docs'
+Description-Content-Type: text/markdown
+
+# rfmeasurement
+
+[![Documentation Status](https://readthedocs.org/projects/rfmeasurement/badge/?version=latest)](https://rfmeasurement.readthedocs.io/en/latest/?badge=latest)
+
+An open-source Python framework for uncertainty-aware validation and
+reproducible analysis of RF measurements.
+
+> **Status: early alpha (`0.1.0`).** The public API is not yet stable and
+> may change without notice between `0.x` releases. See the
+> [roadmap](docs/roadmap.md) for current progress and the
+> [changelog](CHANGELOG.md) for release notes.
+
+**Documentation:** <https://rfmeasurement.readthedocs.io/en/latest/>
+
+## Statement of need
+
+RF measurement data (S-parameters and related quantities) is commonly
+analyzed without a structured record of measurement quality, uncertainty,
+or provenance. `rfmeasurement` adds a layer on top of established RF
+network-analysis tooling to turn raw measurement data into **validated,
+uncertainty-aware, reproducible scientific results**.
+
+> Do not only report an RF result. Report how the result was obtained,
+> how trustworthy the measurement is, and what uncertainty contributes to
+> the final value.
+
+`rfmeasurement` does not replace [scikit-rf](https://scikit-rf.readthedocs.io/);
+it builds on it, focusing on measurement provenance, measurement-quality
+assessment, uncertainty modelling and propagation, and reproducible
+reporting. See [docs/scope.md](docs/scope.md) for the boundary between the
+two projects.
+
+## Documentation
+
+The published documentation (installation, API reference, contributing,
+license) is at <https://rfmeasurement.readthedocs.io/en/latest/>.
+
+The full design and development specification lives in [docs/](docs/index.md):
+
+- [Vision](docs/vision.md)
+- [Scope](docs/scope.md)
+- [Requirements](docs/requirements.md)
+- [Architecture](docs/architecture.md)
+- [Domain model](docs/domain-model.md)
+- [API specification](docs/api-specification.md)
+- [Uncertainty](docs/uncertainty.md)
+- [Measurement quality](docs/measurement-quality.md)
+- [Reproducibility](docs/reproducibility.md)
+- [Roadmap](docs/roadmap.md)
+- [Repository organisation](docs/repository-organization.md)
+- [Testing and validation](docs/testing-validation.md)
+- [Architecture Decision Records](docs/adr/)
+
+## Installation
+
+Not yet published to PyPI. Install from a tagged release or from source:
+
+```bash
+pip install "rfmeasurement @ git+https://github.com/telmomm/rfmeasurement.git@v0.1.0"
+```
+
+For development:
+
+```bash
+git clone https://github.com/telmomm/rfmeasurement.git
+cd rfmeasurement
+python -m pip install -e ".[dev]"
+```
+
+Supported Python versions: 3.10, 3.11, 3.12, 3.13.
+
+## Development
+
+```bash
+pytest
+```
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for how to propose changes,
+including scientific contributions.
+
+## Citation
+
+If you use `rfmeasurement` in research, please cite it using the metadata
+in [CITATION.cff](CITATION.cff).
+
+## License
+
+BSD 3-Clause License. See [LICENSE](LICENSE).
+
+## Code of conduct
+
+This project follows the [Contributor Covenant](CODE_OF_CONDUCT.md).