diff --git a/README.rf b/README.rf index 5b517669c..7e21117f2 100644 --- a/README.rf +++ b/README.rf @@ -4,3 +4,59 @@ some have been slightly modified, compatibility with VS 2022 is achieved. PSS and HB have been tested on a few examples. Documentaion and further testing are due, as well as finally adding suitable commit messages. + +Commands available: + + +Writing two-port or multi(N)-port S parameters +spar_write() (2-port) or spar_write_np() (N-port) + +Periodic steady state (PSS) +pss + +Periodic AC (PAC) +pac + +PNOISE +pnoise + +Periodic transfer function (PXF) +pxf [max sideband] + +Cyclostationary noise +pnoise cyclo + +Periodic S parameters +psp [max sideband] + +Quasi-periodic two-tone steady state (QPSS) +qpss [periods] [max order] + | e.g. V(out) + +Harmonic Balance (HB) +hb [points] [maxiter] + +Two-tone HB (frequency domain QPSS) +qpss hb + +Two-tone small-signal QPAC (quasi periodic AC) +qpss hb +qpac + +Two-tone small-signal Qnoise (quasi periodic noise) +qpss hb +qnoise + +Cyclo stationary QPNOISE +qnoise cyclo + +Oscillator phase noise (autonomous HB plus phase noise) +hbosc + +Two-tone small-signal quasi-periodic transfer function QPXF +qpss hb +qpxf + +QPAC, QPnoise, and QPXF may be swept over frequency instead of fixed f_in, e.g. +replace 'qpxf ' by 'qpxf ' +