Skip to main content

ParamRF: Parametric Radio Frequency Modelling, Fitting and Sampling

Project description

Run Tests

paramrf logo

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 and Equinox.

ParamRF
Author Gary Allen
Homepage github.com/paramrf/paramrf
Docs paramrf.github.io/paramrf
Paper ParamRF: A JAX-Native Framework for Declarative Circuit Modelling

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 anesthetic mpi4py

For BlackJAX fitting:

pip install git+https://github.com/handley-lab/blackjax@nested_sampling 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:

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:

@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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

paramrf-0.10.3.tar.gz (8.4 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

paramrf-0.10.3-py3-none-any.whl (146.6 kB view details)

Uploaded Python 3

File details

Details for the file paramrf-0.10.3.tar.gz.

File metadata

  • Download URL: paramrf-0.10.3.tar.gz
  • Upload date:
  • Size: 8.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for paramrf-0.10.3.tar.gz
Algorithm Hash digest
SHA256 c4d1b96d6f5c7a358df58805c223f599ad52298290d43bdb285c8a8662cb1c5d
MD5 8601d1367258f1032a018a3f7f66a377
BLAKE2b-256 21e5e8c5d685d4dd238bec22156c6c4632481205753716069f22ce453a6b3d7a

See more details on using hashes here.

Provenance

The following attestation bundles were made for paramrf-0.10.3.tar.gz:

Publisher: publish.yml on paramrf/paramrf

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file paramrf-0.10.3-py3-none-any.whl.

File metadata

  • Download URL: paramrf-0.10.3-py3-none-any.whl
  • Upload date:
  • Size: 146.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for paramrf-0.10.3-py3-none-any.whl
Algorithm Hash digest
SHA256 41d8a949ced3e2601f3fdacb211ff153e8f1bfb9ea10a88f78f567ccf33ff574
MD5 91259b2d1279676af40d3c87e4b02268
BLAKE2b-256 737c8977c5cbf2438b6882405adc0a81407b5af985b90b530654be11943cd5d4

See more details on using hashes here.

Provenance

The following attestation bundles were made for paramrf-0.10.3-py3-none-any.whl:

Publisher: publish.yml on paramrf/paramrf

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page