summaryrefslogtreecommitdiff
path: root/graphics/pgf/contrib/bodeplot/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'graphics/pgf/contrib/bodeplot/README.md')
-rw-r--r--graphics/pgf/contrib/bodeplot/README.md12
1 files changed, 11 insertions, 1 deletions
diff --git a/graphics/pgf/contrib/bodeplot/README.md b/graphics/pgf/contrib/bodeplot/README.md
index 23733a484e..25b8d7e1dd 100644
--- a/graphics/pgf/contrib/bodeplot/README.md
+++ b/graphics/pgf/contrib/bodeplot/README.md
@@ -5,6 +5,16 @@ Inspired by the `bodegraph` package.
*Version 1.0.8 and newer store `gnuplot` temporary files in the working directory. Use class option `declutter` to restore pre-v1.0.8 behavior. Option `declutter` can cause errors if used with a `tikzexternalize` prefix.*
+Compilation instructions:
+1) `latex bodeplot.ins` to generate `bodeplot.sty`
+2) To compile documentation (needs `gnuplot` on system PATH):
+```
+pdflatex bodeplot.dtx --shell-escape
+makeindex -s gind.ist bodeplot.idx
+makeindex -s gglo.ist -o bodeplot.gls bodeplot.glo
+pdflatex bodeplot.dtx --shell-escape
+pdflatex bodeplot.dtx --shell-escape
+```
Added functionality:
- New `\BodeZPK` and `\BodeTF` commands to generate Bode plots of any transfer function given either poles, zeros, gain, and delay, or numerator and denominator coefficients and delay
- Support for unstable poles and zeros.
@@ -42,4 +52,4 @@ Other new environments and associated commands:
- `\addNyquistZPKPlot[plot-options]{z/{zeros},p/{poles},k/gain,d/delay}`
- `\addNyquistTFPlot[plot-options]{num/{coeff},den/{coeff},d/delay}`
-Limitation: Phase plots from TF commands are wrapped between 0 and 360 degrees. \ No newline at end of file
+Limitation: Nichols charts from TF commands are wrapped between 0 and 360 degrees.