ParamRF, or pmrf, is an open-source radio frequency (RF) design and modeling framework. It provides a declarative syntax for creating microwave circuits and surrogate models using JAX.
The library provides tools for frequency-domain simulation, optimization, fitting, statistical analysis, and Bayesian inference.
- Version:
- Author:
Gary Allen
- GitHub:
- Docs:
- Paper:
Features
Declarative: Models can be composed and defined using an intuitive, object-oriented syntax which feels similar to CAD circuit software.
Hierarchical: By nesting models within models, it is easy to create deep, hierarchical structures.
Differentiable: Since the library is built on jax (as opposed to numpy), derivatives are available via auto-differentiation, enabling faster optimization and new design opportunities.
Parameter-driven: Parameters are first-class citizens, allowing the easy definition and propagation of constraints/distributions through models.
Hardware flexible: Functions are compiled just-in-time (JIT), reducing overhead and allowing computation on high-performance hardware (CPU, GPU, TPU).
Extensible: Power users can easily add additional models and algorithms by extending the library’s built-in classes and interfaces.
Installation
ParamRF can be installed directly using pip (requires Python 3.11+):
$ pip install paramrfExample
The code below demonstrate how to define and optimize an RLC model to satisfy a given goal function. See the documentation for more examples.
import pmrf as prf
from pmrf.models import Resistor, Inductor, Capacitor
R = prf.Unconstrained(50.0, name='R')
L = prf.Bounded(0.0, 100.0, scale=1e-9, name='L')
C = prf.Bounded(0.0, 100.0, scale=1e-12, name='C')
model = Resistor(R) ** Inductor(L) ** Capacitor(C)
goal = prf.objectives.Goal('s11_db', '<', -20)
passband = prf.Frequency(2, 5, 101, 'GHz')
result = prf.optimize.minimize(goal, model, passband, solver=prf.optimize.NelderMead())
plot_freq = prf.Frequency(1, 6, 101, 'GHz')
model.plot_s_db(plot_freq, m=0, n=0, label='initial')
result.model.plot_s_db(plot_freq, m=0, n=0, label='optimized')
print(prf.values(result.model))Next steps
For an overview of the library’s features, see the examples page.
For step-by-step guides that you can follow, check out the tutorials.
To delve a bit deeper into the library’s core building blocks and philosophy, head off to core concepts.
Optional dependencies
Several additional dependencies are required/recommended for more advanced use-cases.
For BlackJAX’s Bayesian solvers:
$ pip install git+https://github.com/handley-lab/blackjax.git@v0.1.0-betaFor the PolyChord solver:
$ pip install git+https://github.com/PolyChord/PolyChordLite.git anesthetic mpi4pyDevelopment Warning
ParamRF is an active research project with an evolving API. Although a large portion of the API has stabilized, until V1.0.0 is reached, minor version bumps (0.X.0) will indicate breaking changes, while patch versions (0.x.Y) will imply new features and/or bug fixes.
Citation
If you have used ParamRF for academic work, please cite the arXiv preprint (https://doi.org/10.48550/arXiv.2510.15881) as:
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 using the 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},
}1 maintainer
Metadata
1 maintainer
Release files for paramrf 0.37.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| paramrf-0.37.4.tar.gz | 6.9 MB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| paramrf-0.37.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 7.2 MB
Release files / paramrf-0.37.4.tar.gz
| Download URL | paramrf-0.37.4.tar.gz |
|---|---|
| Size | 6.9 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fbd51da4d0e5fbf2c0dbcd50eec57bffa23144a72adb0a68323524f7d27963ba
|
|
BLAKE2b-256 checksum How to use checksums |
7177c89c8b81a5f7a6ceb474a359f29c751402cd213c2934036c4d620e0f6fbf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 19, 2026.
Transparency logRelease files / paramrf-0.37.4-py3-none-any.whl
| Download URL | paramrf-0.37.4-py3-none-any.whl |
|---|---|
| Size | 317.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6892fcf93ae7711c8a2754bd286c832aae552fdebb2f75a410fc987702b87cf0
|
|
BLAKE2b-256 checksum How to use checksums |
007f296d2520b53582381250e932b1e882e7453a78425c4c8ad6b2748bbab626
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 19, 2026.
Transparency logSecurity for paramrf 0.37.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for paramrf-0.37.4.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 19, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
