paramrf 0.10.2__tar.gz

paramrf-0.10.2/.github/workflows/deploy_docs.yml

@@ -0,0 +1,36 @@
+name: Deploy Sphinx Docs
+
+on:
+  push:
+    branches: [main]
+
+permissions:
+  contents: write
+
+jobs:
+  build-deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repo
+      uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.11'
+
+    - name: Install dependencies
+      run: |
+        pip install sphinx sphinx_rtd_theme myst-parser ghp-import
+        pip install -e ".[docs]"
+
+    - name: Build docs
+      run: |
+        cd docs
+        make html
+
+    - name: Deploy to GitHub Pages
+      run: |
+        cd docs
+        ghp-import -n -p -f build/html

paramrf-0.10.2/.github/workflows/tests.yml

@@ -0,0 +1,30 @@
+name: Run Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repo
+      uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.11'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install pytest
+        pip install -e .  # Installs your library so tests can find it
+
+    - name: Run Pytest
+      run: |
+        python -m pytest

paramrf-0.10.2/.gitignore

@@ -0,0 +1,174 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc

paramrf-0.10.2/LICENSE

@@ -0,0 +1,62 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+Copyright 2025 Stellenbosch University
+
+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.
+
+
+
+NOTICE REGARDING THIRD-PARTY CODE
+
+This software includes portions of code derived from the scikit-rf project
+(https://github.com/scikit-rf/scikit-rf), which is licensed under the
+BSD 3-Clause License.
+
+The following license applies to those portions:
+
+----------------------------------------------------------------------
+BSD 3-Clause License
+
+Copyright (c) 2011, Scikit-rf Developers
+All rights reserved.
+
+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 scikit-rf 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.
+----------------------------------------------------------------------
+

paramrf-0.10.2/PKG-INFO

@@ -0,0 +1,101 @@
+Metadata-Version: 2.4
+Name: paramrf
+Version: 0.10.2
+Summary: ParamRF: Parametric Radio Frequency Modelling, Fitting and Sampling
+Author-email: Gary Allen <gvcallen@gmail.com>
+Project-URL: homepage, https://github.com/paramrf/paramrf
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: equinox
+Requires-Dist: jax
+Requires-Dist: jaxtyping
+Requires-Dist: h5py
+Requires-Dist: matplotlib
+Requires-Dist: numpy
+Requires-Dist: numpyro
+Requires-Dist: jsonpickle
+Requires-Dist: cloudpickle
+Requires-Dist: scikit-rf
+Requires-Dist: scipy
+Requires-Dist: joblib
+Requires-Dist: tqdm
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: myst-parser; extra == "docs"
+Requires-Dist: ghp-import; extra == "docs"
+Requires-Dist: sphinx-rtd-theme; extra == "docs"
+Requires-Dist: sphinx-math-dollar; extra == "docs"
+Dynamic: license-file
+
+[![Run Tests](https://github.com/paramrf/paramrf/actions/workflows/tests.yml/badge.svg)](https://github.com/paramrf/paramrf/actions/workflows/tests.yml)
+
+![paramrf logo](assets/logo.png)
+
+# ParamRF: Parametric Radio Frequency Modelling, Fitting and Sampling
+
+**ParamRF**, or ``pmrf``, is an open-source radio frequency (RF) modelling framework. It provides an object-orientated means of modelling, fitting and sampling both circuit and numerical RF models in the frequency-domain, using [JAX](https://github.com/jax-ml/jax) and [Equinox](https://github.com/patrick-kidger/equinox).
+
+| **ParamRF** |  |
+|-------------|-------|
+| **Author**  | Gary Allen |
+| **Homepage** | [github.com/paramrf/paramrf](https://github.com/paramrf/paramrf) |
+| **Docs** | [paramrf.github.io/paramrf](https://paramrf.github.io/paramrf) |
+| **Paper** | [ParamRF: A JAX-Native Framework for Declarative Circuit Modelling](https://doi.org/10.48550/arXiv.2510.15881) |
+
+## Installation
+ParamRF can be installed using pip directly:
+
+``
+pip install paramrf
+``
+
+### Optional dependencies
+Several additional dependencies are required/recommended for more advanced use-cases.
+
+For PolyChord fitting:
+
+``
+pip install git+https://github.com/PolyChord/PolyChordLite.git
+pip install anesthetic
+pip install mpi4py
+``
+
+For BlackJAX fitting:
+
+``
+pip install git+https://github.com/handley-lab/blackjax@nested_sampling
+pip install anesthetic
+``
+
+For eqx-learn surrogate modeling:
+
+``
+pip install git+https://github.com/eqx-learn/eqx-learn
+``
+
+
+## Citation
+
+If you have used ParamRF for academic work, please cite the original [paper](https://doi.org/10.48550/arXiv.2510.15881):
+
+> G.V.C. Allen, D.I.L. de Villiers, (2025). ParamRF: A JAX-native Framework for Declarative Circuit Modelling. arXiv, https://doi.org/10.48550/arXiv.2510.15881.
+
+or with BibTeX:
+
+```bibtex
+@article{paramrf,
+    doi = {10.48550/arXiv.2510.15881},
+    url = {https://doi.org/10.48550/arXiv.2510.15881}, 
+    year = {2025},
+    month = {Oct},
+    title = {ParamRF: A JAX-native Framework for Declarative Circuit Modelling}, 
+    author = {Gary V. C. Allen and Dirk I. L. de Villiers},
+    eprint = {2510.15881},
+    archivePrefix = {arXiv},
+    primaryClass = {cs.OH},
+}
+```
+
+## Contributions
+
+Since the library is in very early stages and likely contains several bugs, contributions are more than welcome by submitting a PR (especially for the docs!). However, before making any major changes, please open an issue so we can discuss the general intention of the contribution.

paramrf-0.10.2/README.md

@@ -0,0 +1,72 @@
+[![Run Tests](https://github.com/paramrf/paramrf/actions/workflows/tests.yml/badge.svg)](https://github.com/paramrf/paramrf/actions/workflows/tests.yml)
+
+![paramrf logo](assets/logo.png)
+
+# ParamRF: Parametric Radio Frequency Modelling, Fitting and Sampling
+
+**ParamRF**, or ``pmrf``, is an open-source radio frequency (RF) modelling framework. It provides an object-orientated means of modelling, fitting and sampling both circuit and numerical RF models in the frequency-domain, using [JAX](https://github.com/jax-ml/jax) and [Equinox](https://github.com/patrick-kidger/equinox).
+
+| **ParamRF** |  |
+|-------------|-------|
+| **Author**  | Gary Allen |
+| **Homepage** | [github.com/paramrf/paramrf](https://github.com/paramrf/paramrf) |
+| **Docs** | [paramrf.github.io/paramrf](https://paramrf.github.io/paramrf) |
+| **Paper** | [ParamRF: A JAX-Native Framework for Declarative Circuit Modelling](https://doi.org/10.48550/arXiv.2510.15881) |
+
+## Installation
+ParamRF can be installed using pip directly:
+
+``
+pip install paramrf
+``
+
+### Optional dependencies
+Several additional dependencies are required/recommended for more advanced use-cases.
+
+For PolyChord fitting:
+
+``
+pip install git+https://github.com/PolyChord/PolyChordLite.git
+pip install anesthetic
+pip install mpi4py
+``
+
+For BlackJAX fitting:
+
+``
+pip install git+https://github.com/handley-lab/blackjax@nested_sampling
+pip install anesthetic
+``
+
+For eqx-learn surrogate modeling:
+
+``
+pip install git+https://github.com/eqx-learn/eqx-learn
+``
+
+
+## Citation
+
+If you have used ParamRF for academic work, please cite the original [paper](https://doi.org/10.48550/arXiv.2510.15881):
+
+> G.V.C. Allen, D.I.L. de Villiers, (2025). ParamRF: A JAX-native Framework for Declarative Circuit Modelling. arXiv, https://doi.org/10.48550/arXiv.2510.15881.
+
+or with BibTeX:
+
+```bibtex
+@article{paramrf,
+    doi = {10.48550/arXiv.2510.15881},
+    url = {https://doi.org/10.48550/arXiv.2510.15881}, 
+    year = {2025},
+    month = {Oct},
+    title = {ParamRF: A JAX-native Framework for Declarative Circuit Modelling}, 
+    author = {Gary V. C. Allen and Dirk I. L. de Villiers},
+    eprint = {2510.15881},
+    archivePrefix = {arXiv},
+    primaryClass = {cs.OH},
+}
+```
+
+## Contributions
+
+Since the library is in very early stages and likely contains several bugs, contributions are more than welcome by submitting a PR (especially for the docs!). However, before making any major changes, please open an issue so we can discuss the general intention of the contribution.

paramrf-0.10.2/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

paramrf-0.10.2/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

paramrf-0.10.2/docs/source/_templates/autosummary/class.rst

@@ -0,0 +1,14 @@
+{% if fullname.count('.') <= 1 %}
+{% set title = "**" ~ name ~ "** (" ~ fullname ~ ")" %}
+{% else %}
+{% set title = name %}
+{% endif %}
+{{ title }}
+{{ "=" * title|length }}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+   :members:
+   :show-inheritance:
+   :inherited-members:

paramrf-0.10.2/docs/source/_templates/autosummary/function.rst

@@ -0,0 +1,11 @@
+{% if fullname.count('.') <= 1 %}
+{% set title = "**" ~ name ~ "** (" ~ fullname ~ ")" %}
+{% else %}
+{% set title = name %}
+{% endif %}
+{{ title }}
+{{ "=" * title|length }}
+
+.. currentmodule:: {{ module }}
+
+.. autofunction:: {{ objname }}

paramrf-0.10.2/docs/source/_templates/autosummary/module.rst

@@ -0,0 +1,54 @@
+{% if fullname.count('.') <= 1 %}
+{% set title = "**" ~ name ~ "** (" ~ fullname ~ ")" %}
+{% else %}
+{% set title = name %}
+{% endif %}
+{{ title }}
+{{ "=" * title|length }}
+
+.. automodule:: {{ fullname }}
+   :no-members:
+   :no-inherited-members:
+
+{% block modules %}
+{% if modules %}
+.. rubric:: Modules
+
+.. autosummary::
+   :toctree:
+   :template: autosummary/module.rst
+   :recursive:
+
+{% for item in modules %}
+   {{ item }}
+{%- endfor %}
+{% endif %}
+{% endblock %}
+
+{% block classes %}
+{% if classes %}
+.. rubric:: Classes
+
+.. autosummary::
+   :toctree:
+   :template: autosummary/class.rst
+
+{% for item in classes %}
+   {{ item }}
+{%- endfor %}
+{% endif %}
+{% endblock %}
+
+{% block functions %}
+{% if functions %}
+.. rubric:: Functions
+
+.. autosummary::
+   :toctree:
+   :template: autosummary/function.rst
+
+{% for item in functions %}
+   {{ item }}
+{%- endfor %}
+{% endif %}
+{% endblock %}

paramrf-0.10.2/docs/source/api/generated/pmrf.Frequency.rst

@@ -0,0 +1,12 @@
+
+
+
+**Frequency** (pmrf.Frequency)
+==============================
+
+.. currentmodule:: pmrf
+
+.. autoclass:: Frequency
+   :members:
+   :show-inheritance:
+   :inherited-members:

paramrf-0.10.2/docs/source/api/generated/pmrf.Model.rst

@@ -0,0 +1,12 @@
+
+
+
+**Model** (pmrf.Model)
+======================
+
+.. currentmodule:: pmrf
+
+.. autoclass:: Model
+   :members:
+   :show-inheritance:
+   :inherited-members:

paramrf-0.10.2/docs/source/api/generated/pmrf.Parameter.rst

@@ -0,0 +1,12 @@
+
+
+
+**Parameter** (pmrf.Parameter)
+==============================
+
+.. currentmodule:: pmrf
+
+.. autoclass:: Parameter
+   :members:
+   :show-inheritance:
+   :inherited-members:

paramrf-0.10.2/docs/source/api/generated/pmrf.algorithms.get_anomaly_mask.rst

@@ -0,0 +1,9 @@
+
+
+
+get_anomaly_mask
+================
+
+.. currentmodule:: pmrf.algorithms
+
+.. autofunction:: get_anomaly_mask

paramrf-0.10.2/docs/source/api/generated/pmrf.algorithms.has_converged.rst

@@ -0,0 +1,9 @@
+
+
+
+has_converged
+=============
+
+.. currentmodule:: pmrf.algorithms
+
+.. autofunction:: has_converged

paramrf-0.10.2/docs/source/api/generated/pmrf.algorithms.has_converged_by_absolute_tolerance.rst

@@ -0,0 +1,9 @@
+
+
+
+has_converged_by_absolute_tolerance
+===================================
+
+.. currentmodule:: pmrf.algorithms
+
+.. autofunction:: has_converged_by_absolute_tolerance