commit 106c50a81c5df79bfe2a1f4c211237cae3aaee94 parent d2e943b4b53a53b5bdbb1c8c47aefaa43b47b063 Author: Martin Kloeckner <mjkloeckner@gmail.com> Date: Fri, 1 May 2026 14:02:44 -0300 Add quick start section Diffstat:
| M | README.md | | | 21 | +++++++++++++++++++++ |
1 file changed, 21 insertions(+), 0 deletions(-) diff --git a/README.md b/README.md @@ -12,3 +12,24 @@ the control package[^2] need to be installed. <img src="nyqlog_octave_version_dark.png" width="100%"> <p align="center"><em>Nyquist plot with logarithmic amplitudes</em></p> </div> + +## Quick start + +Place the file `nyqlog.m` in Octave's path. See +[https://docs.octave.org/v11.1.0/Manipulating-the-Load-Path.html](https://docs.octave.org/v11.1.0/Manipulating-the-Load-Path.html). +Then load the control package [^2] and define a transfer function. Finally call +the `nyqlog` function passing as argument the transfer function. + +```shell +octave:1> pkg load control +octave:2> sys = zpk([-1/3 -1/2], [0 -0.02 -0.1 -2 -10], 48) + +Transfer function 'sys' from input 'u1' to output ... + + 48 s^2 + 40 s + 8 + y1: ------------------------------------------------ + s^5 + 12.12 s^4 + 21.44 s^3 + 2.424 s^2 + 0.04 s + +Continuous-time model. +octave:3> nyqlog(sys) +```