Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/release-drafter.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name-template: '$RESOLVED_VERSION'
tag-template: '$RESOLVED_VERSION'
change-template: '- $TITLE [#$NUMBER](https://github.com/flaport/sax/pull/$NUMBER)'
change-template: '- $TITLE [#$NUMBER](https://github.com/gdsfactory/sax/pull/$NUMBER)'
template: |
# What's Changed

Expand Down
8 changes: 0 additions & 8 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,14 +43,6 @@ jobs:
uses: astral-sh/setup-uv@v5
- name: Install Just
uses: taiki-e/install-action@just
- name: Install Rust
uses: actions-rs/toolchain@v1
with:
toolchain: stable
override: true
components: rustfmt, clippy, cargo
- name: Install svgbob
run: cargo install svgbob_cli
- name: Build docs
run: just dev nbdocs docs
- name: Upload artifact [site]
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ dive in...

## Quick Start

[Full Quick Start page](https://flaport.github.io/sax/nbs/examples/01_quick_start) - [Documentation](https://flaport.github.io/sax).
[Full Quick Start page](https://gdsfactory.github.io/sax/nbs/examples/01_quick_start) - [Documentation](https://gdsfactory.github.io/sax).

Let's first import the SAX library, along with JAX and the JAX-version of numpy:

Expand Down Expand Up @@ -119,7 +119,7 @@ plt.show()
![output](docs/assets/output_10_0.png)

Those are the basics. For more info, check out the **full**
[SAX Quick Start page](https://flaport.github.io/sax/nbs/examples/01_quick_start) or the rest of the [Documentation](https://flaport.github.io/sax).
[SAX Quick Start page](https://gdsfactory.github.io/sax/nbs/examples/01_quick_start) or the rest of the [Documentation](https://gdsfactory.github.io/sax).

## Installation

Expand All @@ -138,4 +138,4 @@ pip install 'sax[dev]'

## License

Copyright © 2025, Floris Laporte, [Apache-2.0 License](https://github.com/flaport/sax/blob/master/LICENSE)
Copyright © 2025, Floris Laporte, [Apache-2.0 License](https://github.com/gdsfactory/sax/blob/main/LICENSE)
281 changes: 0 additions & 281 deletions docs/hooks.py

This file was deleted.

10 changes: 5 additions & 5 deletions docs/models_rf.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
# Radio frequency (RF) Models

For more information on these RF models, see Ref. [@pozar-2012].
For more information on these RF models, see Pozar (2012).

## Coplanar Waveguides (CPW) and Microstrips

Sax includes JAX-jittable functions for computing the characteristic impedance, effective permittivity, and propagation constant of coplanar waveguides and microstrip lines. All results are obtained analytically so the functions compose freely with JAX transformations (`jit`, `grad`, `vmap`, etc.).

### CPW Theory

The quasi-static CPW analysis follows the conformal-mapping approach described by Simons [@simonsCoplanarWaveguideCircuits2001] (ch. 2) and Ghione & Naldi [@ghioneAnalyticalFormulasCoplanar1984]. Conductor thickness corrections use the first-order formulae of Gupta, Garg, Bahl & Bhartia [@guptaMicrostripLinesSlotlines1996] (§7.3, Eqs. 7.98-7.100).
The quasi-static CPW analysis follows the conformal-mapping approach described by Simons (ch. 2) and Ghione & Naldi. Conductor thickness corrections use the first-order formulae of Gupta, Garg, Bahl & Bhartia (§7.3, Eqs. 7.98-7.100).

### Microstrip Theory

The microstrip analysis uses the Hammerstad-Jensen [@hammerstadAccurateModelsMicrostrip1980] closed-form expressions for effective permittivity and characteristic impedance, as presented in Pozar [@pozar-2012] (ch. 3, §3.8).
The microstrip analysis uses the Hammerstad-Jensen closed-form expressions for effective permittivity and characteristic impedance, as presented in Pozar (ch. 3, §3.8).

### General

The ABCD-to-S-parameter conversion is the standard microwave-network relation from Pozar [@pozar-2012] (ch. 4).
The ABCD-to-S-parameter conversion is the standard microwave-network relation from Pozar (ch. 4).

The implementation was cross-checked against the Qucs-S model (see Qucs technical documentation [@qucs_technical_papers], §12 for CPW, §11 for microstrip) and the `scikit-rf` CPW class.
The implementation was cross-checked against the Qucs-S model (see Qucs technical documentation, §12 for CPW, §11 for microstrip) and the `scikit-rf` CPW class.

::: sax.models.rf
Loading
Loading