Scikit-rf

What's Changed
Important Changes in `Media`
* Refactor media to simplify line creation by mhuser in https://github.com/scikit-rf/scikit-rf/pull/727

The Media class has been refactored to simplify the API and avoid confusions related to the impedances. The `z0` property now returns by default the Characteristic Impedance of the media (also available from `z0_characteristic`) if the property `z0_override` is defined, `z0` returns `z0_override` instead of the Characteristic Impedance.

The `embed` argument and the parameters `Z0` (capital) have been deprecated. If the property `z0_port` is defined, all lines will be renormalized from `z0` to `z0_port`, like in a measurement with `z0_port`. Please refer to the [Media tutorial](https://scikit-rf.readthedocs.io/en/latest/tutorials/Media.html) more additional information and a clear explanation of the different between port and characteristic impedances.

New Features
* Add gain properties by keikawa in https://github.com/scikit-rf/scikit-rf/pull/908

New properties have been added to a Network: maximum stable gain (`max_stable_gain`), Maximum available power gain (`max_gain`) and Mason's unilateral gain (`unilateral_gain`)

Improvements
* Vectorize drop_non_monotonic_increasing by eendebakpt in https://github.com/scikit-rf/scikit-rf/pull/882
* Improve performance network.copy by eendebakpt in https://github.com/scikit-rf/scikit-rf/pull/875

Bug Fixes
* Make Network.copy also copy params dict by cafeclimber in https://github.com/scikit-rf/scikit-rf/pull/887
* Fix incorrect z0 handling in SeriesImpedance and ShuntAdmittance by Ttl in https://github.com/scikit-rf/scikit-rf/pull/885
* Handle non-zero length thru in TRL by Ttl in https://github.com/scikit-rf/scikit-rf/pull/896
* Resolve singularities for matched thru and line in determine_reflect by eendebakpt in https://github.com/scikit-rf/scikit-rf/pull/870
* Timescale by FranzForstmayr in https://github.com/scikit-rf/scikit-rf/pull/900
* Allow NISTMultilineTRL to work with non-exact floats by eendebakpt in https://github.com/scikit-rf/scikit-rf/pull/895
* Handle division by zero in stability by Ttl in https://github.com/scikit-rf/scikit-rf/pull/910

Code Quality/CI
* Create dependabot.yml by jhillairet in https://github.com/scikit-rf/scikit-rf/pull/898
* [pre-commit] ruff by jhillairet in https://github.com/scikit-rf/scikit-rf/pull/892
* disable upper limits by FranzForstmayr in https://github.com/scikit-rf/scikit-rf/pull/893

Documentation
* Prepare media tutorial for characteristic impedance implementation change by mhuser in https://github.com/scikit-rf/scikit-rf/pull/888
* Fix doc links from Circuit tutorial to Circuit convenience methods by caryan in https://github.com/scikit-rf/scikit-rf/pull/897
* just fixing a small typo I spotted :-) by Patarimi in https://github.com/scikit-rf/scikit-rf/pull/876
* Fix docstring for Frequency.unit by eendebakpt in https://github.com/scikit-rf/scikit-rf/pull/879
* URL updated. by wollmich in https://github.com/scikit-rf/scikit-rf/pull/881
* Fix installation documentation by jhillairet in https://github.com/scikit-rf/scikit-rf/pull/907

New Contributors
* Patarimi made their first contribution in https://github.com/scikit-rf/scikit-rf/pull/876
* wollmich made their first contribution in https://github.com/scikit-rf/scikit-rf/pull/881
* caryan made their first contribution in https://github.com/scikit-rf/scikit-rf/pull/897

**Full Changelog**: https://github.com/scikit-rf/scikit-rf/compare/v.0.26.0...v0.27.0

New Features
* Add shunt_resistor by jhillairet in https://github.com/scikit-rf/scikit-rf/pull/853
* Create variables to modify nudge_eig thresholds by jhillairet in https://github.com/scikit-rf/scikit-rf/pull/859

Improvements
* Do not generate subnetworks all the time but provide them dynamically by FranzForstmayr in https://github.com/scikit-rf/scikit-rf/pull/810
* improve performance of Coaxial.from_attenuation by eendebakpt in https://github.com/scikit-rf/scikit-rf/pull/871

Bug Fix
* Fix CITI parser by jhillairet in https://github.com/scikit-rf/scikit-rf/pull/854
* Fix division by zero warnings in determine_line by eendebakpt in https://github.com/scikit-rf/scikit-rf/pull/868
* Fix reading/writing HFSS Touchstone files using the 'power' S-param definition by jhillairet in https://github.com/scikit-rf/scikit-rf/pull/869

Community, Code Quality and Continuous Integration
* Adding issue templates by jhillairet in https://github.com/scikit-rf/scikit-rf/pull/862
* [pre-commit] pre-commit configuration: blank lines and trailing spaces by jhillairet in https://github.com/scikit-rf/scikit-rf/pull/863 and https://github.com/scikit-rf/scikit-rf/pull/873
* [pre-commit] trailing spaces and end lines by jhillairet in https://github.com/scikit-rf/scikit-rf/pull/867

Documentation
* Remove duplicate files in documentation by jhillairet in https://github.com/scikit-rf/scikit-rf/pull/861

**Full Changelog**: https://github.com/scikit-rf/scikit-rf/compare/v0.25.0...v.0.26.0

The release 0.25.0 of scikit-rf includes several new features, with for example:
- Calibrating multi-port (N>2) networks is now possible thanks to Ttl. See [Multi-port calibration documentation](https://scikit-rf.readthedocs.io/en/latest/examples/metrology/Multi-port%20Calibration.html).
- Making copy of a Network is now 4 times faster than before thanks to eendebakpt
- Adds an option for custom pole spacing in Vector Fitting thanks to Vinc0110

The complete list of changes is found below. We welcome two new contributors eendebakpt and ericwrice for their work!

New Features
* Multi-port calibration by Ttl in https://github.com/scikit-rf/scikit-rf/pull/818
* Vector Fitting: Custom pole initialization by Vinc0110 in https://github.com/scikit-rf/scikit-rf/pull/845


Improvements
* Improve performance of Network.copy by eendebakpt in https://github.com/scikit-rf/scikit-rf/pull/828
* Add name argument to two_port_reflect by eendebakpt in https://github.com/scikit-rf/scikit-rf/pull/829
* Overlap dut and dummy networks in deembedding by ericwrice in https://github.com/scikit-rf/scikit-rf/pull/834
* Adding parameter `draw_labels` to `plot_smith()`. by Vinc0110 in https://github.com/scikit-rf/scikit-rf/pull/826

Documentation
* Improve error message in NIST TRL calibration by eendebakpt in https://github.com/scikit-rf/scikit-rf/pull/827
* Fix inductor units in media docstrings by ericwrice in https://github.com/scikit-rf/scikit-rf/pull/835

Bug Fixes
* Fix get_sparameter_names order for two-port by Ttl in https://github.com/scikit-rf/scikit-rf/pull/822
* Fix NetworkSet division by cafeclimber in https://github.com/scikit-rf/scikit-rf/pull/843
* Fix shade_bands overwriting y_range (742) by ericwrice in https://github.com/scikit-rf/scikit-rf/pull/838
* Use fft_window when specified and not window by FranzForstmayr in https://github.com/scikit-rf/scikit-rf/pull/802


Code Quality
* Add test for input networks of OnePort calibration by eendebakpt in https://github.com/scikit-rf/scikit-rf/pull/844
* Misc fixes by eendebakpt in https://github.com/scikit-rf/scikit-rf/pull/808
* Remove unneeded print by FranzForstmayr in https://github.com/scikit-rf/scikit-rf/pull/801
* Fix Python 3.7 flake8 by Ttl in https://github.com/scikit-rf/scikit-rf/pull/820
* Dynamically load version from __init__.py by Vinc0110 in https://github.com/scikit-rf/scikit-rf/pull/837
* Small cleanup in calibration methods by eendebakpt in https://github.com/scikit-rf/scikit-rf/pull/836
* Vector Fitting: Tests by Vinc0110 in https://github.com/scikit-rf/scikit-rf/pull/850
* Increasing rtol for sweep type tests by Vinc0110 in https://github.com/scikit-rf/scikit-rf/pull/847

New Contributors
* eendebakpt made their first contribution in https://github.com/scikit-rf/scikit-rf/pull/808
* ericwrice made their first contribution in https://github.com/scikit-rf/scikit-rf/pull/835

**Full Changelog**: https://github.com/scikit-rf/scikit-rf/compare/v0.24.1...v0.25.0

This release contains new features for time gating, make qtapps runable again and fixes related to matplotlib dependency.

Note that new warnings related to the default frequency and time unit are now generated if the frequency or time units are not explicitly passed. Indeed, SI units will used by default for frequency (Hz) and time (s) in future versions of scikit-rf, instead of GHz and ns as presently. It is thus recommended to pass explicitly the units in order to avoid surprises in future versions...

New Features
* `time.time_gate()` has a new parameter `method` added, to choose how to perform gating either by convolution, by FFT (band-pass mode), or by RFFT (low-pass mode). Defaults is FFT. Also, another parameter `fft_window` is added, which enables frequency-domain windowing in case of FFT and RFFT mode. The default is a Hann window, but windowing can be disabled by setting `fft_window=None`. by Vinc0110 in https://github.com/scikit-rf/scikit-rf/pull/770
* qtapps are now runable again by FranzForstmayr in https://github.com/scikit-rf/scikit-rf/pull/790

Changes of behaviour
* Warn users about future change of the default frequency unit by jhillairet in https://github.com/scikit-rf/scikit-rf/pull/792
* Time ns warning by FranzForstmayr in https://github.com/scikit-rf/scikit-rf/pull/799

Fixes
* matplotlib as optional dependency by FranzForstmayr in https://github.com/scikit-rf/scikit-rf/pull/785

Documentation
* Add warnings in the Circuit tutorial by jhillairet in https://github.com/scikit-rf/scikit-rf/pull/798

Continuous Integration
* Update the checkout and setup-python GA versions by jhillairet in https://github.com/scikit-rf/scikit-rf/pull/793
* update to pytest-cov ~=4.0 and drop the deprecation warning ignore by altendky in https://github.com/scikit-rf/scikit-rf/pull/784

New Contributors
* altendky made their first contribution in https://github.com/scikit-rf/scikit-rf/pull/784

**Full Changelog**: https://github.com/scikit-rf/scikit-rf/compare/v0.24.0...v0.24.1

The version 0.24 of scikit-rf includes a lot of improvements and bug fixes.

Note that this version officially drops the support for Python 3.6. The minimum required python version is thus now Python 3.7.

Improvements and new features
* Improvement of the accurary of the OpenShort and ShortOpen de-embedding by keikawa in https://github.com/scikit-rf/scikit-rf/pull/739.
* (Huge) Speed improvement in the `s2s` function, particularly useful when working with large matrices (>300 ports), by avoiding unecessary conversion of S-matrix definition by qmfrf in https://github.com/scikit-rf/scikit-rf/pull/738
* Fix and Update methods in the virtual instrument module which called deprecated pyvisa methods by cafeclimber in https://github.com/scikit-rf/scikit-rf/pull/409
* New time-domain gating implementation using time-domain multiplication instead of frequency-domain convolution. This gives a speed benefit of multiple orders of magnitude, depending on the number of samples by Vinc0110 in https://github.com/scikit-rf/scikit-rf/pull/735
* `read_all` now sort files by default, to obtain a reproducible behaviour, by xafra in https://github.com/scikit-rf/scikit-rf/pull/746
* Important speed improvement in `network_2_dataframe` by stevehamblin in https://github.com/scikit-rf/scikit-rf/pull/761
* Make vector fitting Spice output compatible to LTSpice by FranzForstmayr in https://github.com/scikit-rf/scikit-rf/pull/760
* Added a new operator `>>` for 4-port network cascading with reversed indexing ("1=>2/3=>4" instead than "1=>3/2=>4") by capn-freako in https://github.com/scikit

Documentation
* add a warning in the docstring to inform matlab users of the differences compared to matlab original implementation.
The differences are: i) FIX-2 is flipped (there is already a numbering diagram in docstring) and ii) Better root choice solution to avoid 180° phase jumps in certain circumstances (NZC methods only) by mhuser in https://github.com/scikit-rf/scikit-rf/pull/781
* Updates the documentation to highlight importance of different offset and port impedances, followed by 3 usage examples, close 754. by biergaizi in https://github.com/scikit-rf/scikit-rf/pull/779
* Fixing typo and reference in Qfactor example by jhillairet in https://github.com/scikit-rf/scikit-rf/pull/767-rf/scikit-rf/pull/747

Bug Fixes
* Fix `plot_s_polar()` for matplotlib version >=3.6 (762) by Vinc0110 in https://github.com/scikit-rf/scikit-rf/pull/765
* Vector Fitting: bugfix for data including dc samples by Vinc0110 in https://github.com/scikit-rf/scikit-rf/pull/768

Code Quality Improvements and Continuous Integration
An important work has been made by FranzForstmayr to improve the code quality and to move the codebase to the [PEP 0621](https://peps.python.org/pep-0621/):
* Move requirements specification to PEP 0621 by FranzForstmayr in https://github.com/scikit-rf/scikit-rf/pull/752
* Create codeql.yml by FranzForstmayr in https://github.com/scikit-rf/scikit-rf/pull/772
* Treat all warnings in tests as errors by FranzForstmayr in https://github.com/scikit-rf/scikit-rf/pull/771
* Try to fix rtd build by FranzForstmayr in https://github.com/scikit-rf/scikit-rf/pull/775
* use pyupgrade for python3.7+ by FranzForstmayr in https://github.com/scikit-rf/scikit-rf/pull/776

New Contributors
* qmfrf made their first contribution in https://github.com/scikit-rf/scikit-rf/pull/738
* cafeclimber made their first contribution in https://github.com/scikit-rf/scikit-rf/pull/409
* capn-freako made their first contribution in https://github.com/scikit-rf/scikit-rf/pull/747

**Full Changelog**: https://github.com/scikit-rf/scikit-rf/compare/v0.23.1...v0.24.0

This minor release of scikit-rf contains in particular an important bug fix to the Touchstone's file writing function. In addition, this release includes some simplifications of the handling of the characteristic impedance and on an inconsistent behaviour when passing a network name as `kwarg`. See below for the complete list of changes.`

Bug Fixes
* `write_touchstone`: don't write `z_ref `in complex format if it's real, fix 724 by biergaizi in https://github.com/scikit-rf/scikit-rf/pull/725
* fix an `AttributeError` raised by `Network.renormalize` by mhuser in https://github.com/scikit-rf/scikit-rf/pull/723
* Fix IEEEP370 deembedding methods for dataset with existing DC point or interpolation required by mhuser in https://github.com/scikit-rf/scikit-rf/pull/728

What's Changed
* Simplify `z0` handing by FranzForstmayr in https://github.com/scikit-rf/scikit-rf/pull/720
* fix `media.line` and `media.shunt_xxx` does not keep their network names by mhuser in https://github.com/scikit-rf/scikit-rf/pull/732
* add `makeErrorbox_v8 `and assymetric pullback to IEEEP370 by mhuser in https://github.com/scikit-rf/scikit-rf/pull/719
* Sweep plan unit tests by jjoonathan in https://github.com/scikit-rf/scikit-rf/pull/729


**Full Changelog**: https://github.com/scikit-rf/scikit-rf/compare/v0.23.0...v0.23.1