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 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:

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.2.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.2-py3-none-any.whl (147.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: paramrf-0.10.2.tar.gz
  • Upload date:
  • Size: 8.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for paramrf-0.10.2.tar.gz
Algorithm Hash digest
SHA256 58eebcfc50bae9eacaf11ad628c5675a1c12ce6701ffed39ba4ddc449aafbf4e
MD5 a3df6cd1ad3b0826b39683e4594a6019
BLAKE2b-256 ffa5b20e158abf3d6d475b172ec509be92ec04e2b0997b38b83abede829e45a9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: paramrf-0.10.2-py3-none-any.whl
  • Upload date:
  • Size: 147.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for paramrf-0.10.2-py3-none-any.whl
Algorithm Hash digest
SHA256 7546c4aa723aebc7fdf1be3e4846d421693c5eda5fb2621c0315f44efa92b7e4
MD5 89adba83cf89ee52d750b7b5f0899fb0
BLAKE2b-256 df0e32e800a73d1f0c150475258ccef23f751d7a16751c4b4bceebe630e0668c

See more details on using hashes here.

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