Skip to content

CITING.md

Latest commit

 

History

History
150 lines (110 loc) · 5.28 KB

CITING.md

File metadata and controls

150 lines (110 loc) · 5.28 KB
Raw

Citing and Acknowledging octave-rf

octave-rf is built for the open-source signal integrity community. If you find it useful, we'd love to hear from you, and a citation in your work helps the project grow and earn institutional support.

Say hi 👋

We'd love to hear how you're using octave-rf. Drop a note in GitHub Discussions, or open an issue and we'll tag it community/used-in. Share your use case, send a link to a paper or talk, or just say what's working and what isn't. Public mentions of the package in papers, talks, or downstream tools may be highlighted in the project README with your permission.

In Publications

Suggested acknowledgement language

"This work made use of octave-rf, an open-source GNU Octave package providing S-parameter network utilities for IEEE P370 de-embedding and MATLAB RF Toolbox–compatible analysis."

When journal/conference policies permit, please include a link to https://github.com/Sparamix/octave-rf.

Academic citation

A companion article describing the package design, validation methodology, and case studies is in preparation (TBD). The target venue is one of:

  • IEEE Microwave Magazine
  • Signal Integrity Journal (SIJ)
  • IEEE Electromagnetic Compatibility Magazine

Once published, please cite the article in preference to the software itself. Until then, please cite the software version you used; the recommended form is below.

IEEE-style software citation

G. Maghlakelidze, "octave-rf: S-parameter network utilities for GNU Octave," version 0.1.1, 2026. [Online]. Available: https://github.com/Sparamix/octave-rf/releases/tag/v0.1.1

BibTeX (software)

@software{octave_rf_2026,
  author       = {Maghlakelidze, Giorgi},
  title        = {{octave-rf}: S-parameter network utilities for GNU Octave},
  year         = {2026},
  version      = {0.1.1},
  url          = {https://github.com/Sparamix/octave-rf/releases/tag/v0.1.1},
  note         = {BSD-3-Clause licensed},
  orcid        = {0000-0003-1865-4996},
}

BibTeX (companion article is a placeholder)

@article{octave_rf_TBD,
  author  = {Maghlakelidze, Giorgi},
  title   = {{octave-rf}: An Open-Source GNU Octave Package for IEEE P370
             De-Embedding and MATLAB-Compatible S-Parameter Analysis},
  journal = {IEEE Microwave Magazine / Signal Integrity Journal /
             IEEE Electromagnetic Compatibility Magazine (TBD)},
  year    = {TBD},
  note    = {In preparation. Until published, please cite the software entry above.},
}

GitHub also generates citation metadata automatically from CITATION.cff --> click the "Cite this repository" button in the sidebar on the repo home page.

In Presentations or Applications

If you mention octave-rf in slides, talks, posters, downstream software, or anywhere else, we'd love for you to use the project icon alongside a short attribution. Plain text is also fine:

Powered by octave-rf : https://github.com/Sparamix/octave-rf

Project icon

octave-rf icon

Format File Direct (raw) URL
PNG (256×256) doc/icon.png https://raw.githubusercontent.com/Sparamix/octave-rf/main/doc/icon.png

Drop the icon next to a "Powered by octave-rf" caption in slides, on posters, or in app About boxes. The raw URL above can be hot-linked directly from external Markdown or HTML.

A vector (SVG) version is not yet packaged. If you need SVG or a different size/resolution, please open an issue and we'll add it. Light recoloring or background adjustments to match your slide template are fine. Please don't redraw the icon or use it in a way that implies endorsement of an unrelated product.

Acknowledging the Underlying IEEE P370 Test Data

The examples/ directory bundles Touchstone files from the IEEE P370 open-source repository (notably case_01_*.s2p from TG1). If you use these test files in a publication, please cite IEEE P370 directly in addition to octave-rf:

IEEE P370 Working Group, "IEEE Standard for Electrical Characterization of Printed Circuit Board and Related Interconnects at Frequencies up to 50 GHz," 2020. [Online]. Available: https://opensource.ieee.org/elec-char/ieee-370/

Acknowledging Cross-Validation References

octave-rf is validated against MATLAB RF Toolbox and scikit-rf. If your publication discusses or builds on this validation, please cite those projects as well:

  • scikit-rf: Arsenovic et al., "scikit-rf: An Open Source Python Package for Microwave Network Creation, Analysis, and Calibration [Speaker's Corner]," IEEE Microwave Magazine, vol. 23, no. 1, pp. 98–105, Jan. 2022, doi: 10.1109/MMM.2021.3117139.
  • MATLAB RF Toolbox: The MathWorks, Inc., "RF Toolbox," Natick, MA.

License Note

octave-rf is BSD-3-Clause licensed. The license does not require attribution in derived software, but academic citations are how independent open-source SI tools earn the institutional support they need to keep improving. Thank you for citing.