Scikit-rf

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

The version 0.23 of scikit-rf includes a *lot* of improvements and bug fixes (with a huge work from Ttl , mhuser and biergaizi !)

This new release also includes a new feature, the Quality factor class `Qfactor`, [which allows determining the loaded and unloaded quality factors of a Network](https://scikit-rf.readthedocs.io/en/latest/tutorials/Q-Factor.html).

The development activity of scikit-rf continues to grow! The scikit-rf development team has been consolidated with additional collaborators: Ttl , mhuser, FranzForstmayr and Vinc0110. Welcome and thank you!

New Features
* [Q-factor(s) fitting](https://scikit-rf.readthedocs.io/en/latest/tutorials/Q-Factor.html) by jhillairet in https://github.com/scikit-rf/scikit-rf/pull/637

Improvements
Network and Media
* [Add support for initializing network with different parameters](https://scikit-rf.readthedocs.io/en/latest/tutorials/Networks.html#from-z-parameters) by Ttl in https://github.com/scikit-rf/scikit-rf/pull/657
* More accurate Coaxial resistance model by Ttl in https://github.com/scikit-rf/scikit-rf/pull/649
* Z0 getter fix by Ttl in https://github.com/scikit-rf/scikit-rf/pull/664
* Improve s2z, z2s, s2y and y2s accuracy by Ttl in https://github.com/scikit-rf/scikit-rf/pull/661
* cpw warns if t < 3 * skin_depth by mhuser in https://github.com/scikit-rf/scikit-rf/pull/665
* Consistent Network handling with different s_def by Ttl in https://github.com/scikit-rf/scikit-rf/pull/655
* Refactor CPW media to fix 667 by mhuser in https://github.com/scikit-rf/scikit-rf/pull/676
* Fixing unhandled corner case in Frequency by jhillairet in https://github.com/scikit-rf/scikit-rf/pull/700
* Putting back temporarely .f and .npoints setter for warning users by jhillairet in https://github.com/scikit-rf/scikit-rf/pull/714
* warns of future deprecation of media line parameter embed by mhuser in https://github.com/scikit-rf/scikit-rf/pull/715
* Refactor MLine Media to follow qucs implementation by mhuser in https://github.com/scikit-rf/scikit-rf/pull/650

Circuit
* Mark Circuit Ports with attribute instead of name by Ttl in https://github.com/scikit-rf/scikit-rf/pull/671

Instruments
* Fixed NanoVNA backend configuration for PyVISA-py by Vinc0110 in https://github.com/scikit-rf/scikit-rf/pull/669
* Fix compatibility with python 3.10 by jjoonathan in https://github.com/scikit-rf/scikit-rf/pull/674
* HP8510C Sweep Plan by jjoonathan in https://github.com/scikit-rf/scikit-rf/pull/675

Touchstone, MDIF
* Fix `write_touchstone` with complex or non-equal z0 by Ttl in https://github.com/scikit-rf/scikit-rf/pull/672
* Add `NetworkSet.write_mdif()` method to export NetworkSet to a generalized MDIF file by jrmagers in https://github.com/scikit-rf/scikit-rf/pull/680

Calibration
* LRRM fix for unsymmetric thru, non-iterative lc fit by Ttl in https://github.com/scikit-rf/scikit-rf/pull/682
* IEEEP370 Flip FIX-2 and minor improvements by mhuser in https://github.com/scikit-rf/scikit-rf/pull/698
* Add forced_z11x to IEEEP370_SE_NZC_2xThru and correct typo by mhuser in https://github.com/scikit-rf/scikit-rf/pull/708

Vector Fitting
* Vector Fitting: Some convenience updates by Vinc0110 in https://github.com/scikit-rf/scikit-rf/pull/673
* Vector Fitting: Minor updates by Vinc0110 in https://github.com/scikit-rf/scikit-rf/pull/706

Documentation
* Convert All Documentation Links to Relative Path Links by biergaizi in https://github.com/scikit-rf/scikit-rf/pull/713
* Update logos by jhillairet in https://github.com/scikit-rf/scikit-rf/pull/716
* New example: Defining SOLT calibration standards. by biergaizi in https://github.com/scikit-rf/scikit-rf/pull/663
* Fix SOLT cal kit example HTML rendering by Ttl in https://github.com/scikit-rf/scikit-rf/pull/686
* Adding the IEEEP370 deembedding methods to the docstring by jhillairet in https://github.com/scikit-rf/scikit-rf/pull/689
* SOLT cal kit example: more formatting and typo fixes by biergaizi in https://github.com/scikit-rf/scikit-rf/pull/690
* Minor changes in IEEE P370 doc by jhillairet in https://github.com/scikit-rf/scikit-rf/pull/694
* New example: [Defining SOLT calibration standards](https://scikit-rf.readthedocs.io/en/latest/examples/metrology/SOLT%20Calibration%20Standards%20Creation.html). by biergaizi in https://github.com/scikit-rf/scikit-rf/pull/663
* Documentation updates by jhillairet in https://github.com/scikit-rf/scikit-rf/pull/709
* [Three Receivers Calibration](https://scikit-rf.readthedocs.io/en/latest/examples/metrology/Calibration%20With%20Three%20Receivers.html): Add Reference to NanoVNA by biergaizi in https://github.com/scikit-rf/scikit-rf/pull/712
* [Three Receivers Calibration](https://scikit-rf.readthedocs.io/en/latest/examples/metrology/Calibration%20With%20Three%20Receivers.html): clarify SOLT procedures and source port. by biergaizi in https://github.com/scikit-rf/scikit-rf/pull/711
* [Explain Isolation Calibration in SOLT calibration tutorial and example](https://scikit-rf.readthedocs.io/en/latest/examples/metrology/SOLT.html) by biergaizi in https://github.com/scikit-rf/scikit-rf/pull/710
* Add higher number of ports examples to se2gmm by mhuser in https://github.com/scikit-rf/scikit-rf/pull/707

Bug fixes
* Avoid division by zero at 0 Hz in DistributedCircuit by Ttl in https://github.com/scikit-rf/scikit-rf/pull/658
* Fix for 662 and other minor corrections by Vinc0110 in https://github.com/scikit-rf/scikit-rf/pull/666
* fix 684 phase jumps in 2xthru deembedding by mhuser in https://github.com/scikit-rf/scikit-rf/pull/687
* Remove comparison to CPW model from MTRL example by Ttl in https://github.com/scikit-rf/scikit-rf/pull/695
* Vector Fitting: Bug fix for 677 and 702 by Vinc0110 in https://github.com/scikit-rf/scikit-rf/pull/678
* drop_non_monotonic_increasing fix for 2D z0 shape by Ttl in https://github.com/scikit-rf/scikit-rf/pull/705

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

Minor release, mostly to fix a 640

What's Changed
* fix 640 and add tests for non-uniform frequency array by jhillairet in https://github.com/scikit-rf/scikit-rf/pull/641
* Keep port_names when using subnetwork by jhillairet in https://github.com/scikit-rf/scikit-rf/pull/638
* Reduce various warnings in unit tests by jhillairet in https://github.com/scikit-rf/scikit-rf/pull/639

**Full Changelog**: https://github.com/scikit-rf/scikit-rf/compare/v0.22.0...v0.22.1

Release 0.22 of scikit-rf includes a new feature and important bug fixes, as well as other improvements, new or improved documentation and bug fixes.


New Features
* Implement IEEEP370 NZC and ZC deembedding methods by mhuser in https://github.com/scikit-rf/scikit-rf/pull/628
* Virtual Instruments: Adding NanoVNA V2 support by Vinc0110 in https://github.com/scikit-rf/scikit-rf/pull/616

Improvements
* se2gmm z0 broadcasting, docstring and tests by Ttl in https://github.com/scikit-rf/scikit-rf/pull/635
* Vector fitting: code reorganization + speed improvements by Vinc0110 in https://github.com/scikit-rf/scikit-rf/pull/614
* Correct Network.f property return type-hint by lstuemke in https://github.com/scikit-rf/scikit-rf/pull/612
* Forbid duplicates in Circuit connection description by jhillairet in https://github.com/scikit-rf/scikit-rf/pull/619

Bug Fixes
* Fix gmm2se phase inversion by Ttl in https://github.com/scikit-rf/scikit-rf/pull/632
* Fix618 scipy.ndimage.filters namespace deprecation warning by l-johnston in https://github.com/scikit-rf/scikit-rf/pull/620
* Bug Fix for Parser.py yaml.load deprecated by xreymason in https://github.com/scikit-rf/scikit-rf/pull/621
* Fix numerical issue in TwoPortOnePath by Ttl in https://github.com/scikit-rf/scikit-rf/pull/625

Documentation
* Fixing SOLT description and adding a SOLT calibration example by jhillairet in https://github.com/scikit-rf/scikit-rf/pull/624
* SOLT calibration example: asymmetric case by jhillairet in https://github.com/scikit-rf/scikit-rf/pull/627
* SOLT.ipynb example: suggests using nports=2. by biergaizi in https://github.com/scikit-rf/scikit-rf/pull/630
* editorial changes to notebook only by denzchoe in https://github.com/scikit-rf/scikit-rf/pull/633


We are very happy to welcome new contributors to the project 👍

New Contributors
* lstuemke made their first contribution in https://github.com/scikit-rf/scikit-rf/pull/612
* l-johnston made their first contribution in https://github.com/scikit-rf/scikit-rf/pull/620
* xreymason made their first contribution in https://github.com/scikit-rf/scikit-rf/pull/621
* biergaizi made their first contribution in https://github.com/scikit-rf/scikit-rf/pull/630
* denzchoe made their first contribution in https://github.com/scikit-rf/scikit-rf/pull/633

**Full Changelog**: https://github.com/scikit-rf/scikit-rf/compare/v0.21.0...v0.22.0