Commit 196c9425 authored by Sean Leavey's avatar Sean Leavey
Browse files

Tweak doc build system and docs

parent 0ca0cef4
Pipeline #148473 passed with stage
in 23 minutes and 37 seconds
......@@ -20,11 +20,11 @@ STATICDIR = _static
# Static files
ZEROSTATICDEPS = $(STATICDIR)/liso-input-node-graph.svg
# Native plots with LISO files.
ZEROLISODEPS = $(STATICDIR)/liso-two-noises.svg
ZEROLISODEPS = $(BUILDDIR)/liso-two-noises.svg
# Native/LISO script comparisons.
ZEROLISOCOMPAREDEPS = $(STATICDIR)/liso-compare-response.svg
ZEROLISOCOMPAREDEPS = $(BUILDDIR)/liso-compare-response.svg
# CLI example plots.
CLIOPAMPGAINDEP = $(STATICDIR)/cli-opamp-gain.svg
CLIOPAMPGAINDEP = $(BUILDDIR)/cli-opamp-gain.svg
ZEROCLIPLOTDEPS = $(CLIOPAMPGAINDEP)
.PHONY: help
......@@ -81,12 +81,12 @@ $(CLIOPAMPGAINDEP):
zero library search "gbw > 800M & ((vnoise < 10n & inoise < 10p) | (vnoise < 100n & inoise < 1p)) & model != OP00" --no-plot-gain --save-gain-figure $@ --fstop 1M
# Generate SVG plot of two noise example.
$(STATICDIR)/liso-two-noises.svg:
$(BUILDDIR)/liso-two-noises.svg:
@echo "Generating $@"
zero liso $(STATICDIR)/liso-two-noises/noise1.fil $(STATICDIR)/liso-two-noises/noise2.fil --no-plot --save-figure $@
# Generate SVG plots comparing Zero to LISO using LISO files.
$(STATICDIR)/%.svg: $(STATICDIR)/liso-compare/%.fil
$(BUILDDIR)/%.svg: $(STATICDIR)/liso-compare/%.fil
@echo "Generating $@ from $<"
zero liso $< --compare --no-plot --save-figure $@
......
......@@ -163,7 +163,7 @@ The following command will produce the plot below.
$ zero library search "gbw > 800M & ((vnoise < 10n & inoise < 10p) | (vnoise < 100n & inoise < 1p)) & model != OP00" --plot-gain --fstop 1M
.. image:: /_static/cli-opamp-gain.svg
.. image:: /_build/cli-opamp-gain.svg
Command reference
-----------------
......
......@@ -94,7 +94,7 @@ input file itself and with LISO, then it will parse the LISO results and combine
The resulting plot then contains each function, with the native results with solid lines and the
LISO results with dashed lines:
.. image:: /_static/liso-compare-response.svg
.. image:: /_build/liso-compare-response.svg
A textual representation of the differences can also be displayed by specifying ``--diff``. This
must be provided in addition to ``--compare``. When specified, this prints a table containing
......@@ -114,22 +114,20 @@ they occur:
Simulating multiple input files together
----------------------------------------
Multiple input or output files may be specified in the ``zero liso`` call. These are simulated
separately and the results are merged together such that they can be plotted on one graph if
possible. The results can only be combined with the simulations contain the same frequency vectors.
If they do not have the same frequency vectors, an error is displayed and the program exits.
Multiple input or output files may be specified in the ``zero liso`` call as long as they specify
equivalent frequency vectors. These are each simulated separately and the results are merged
together such that they can be plotted together. This can be useful for example for simulating
similar circuits with different component values on one graph. Each script is plotted with a
different line style and a gradually lighter colour map.
This can be useful for example for simulating similar circuits with different component values on
one graph. Each script is plotted with a different line style and a gradually lighter colour map.
Here is an example that shows the noise at an output node and the same noise referred to the input
on one plot:
The example below shows the noise at an output node and the same noise referred to the input on one
plot. The respective input filenames are appended to the legend labels.
.. code-block:: bash
$ zero liso noise1.fil noise2.fil
.. image:: /_static/liso-two-noises.svg
.. image:: /_build/liso-two-noises.svg
Contents of ``noise1.fil``:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment