Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
Menu
Open sidebar
Sean Leavey
Zero
Commits
196c9425
Commit
196c9425
authored
Aug 18, 2020
by
Sean Leavey
Browse files
Tweak doc build system and docs
parent
0ca0cef4
Pipeline
#148473
passed with stage
in 23 minutes and 37 seconds
Changes
3
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
docs/Makefile
View file @
196c9425
...
...
@@ -20,11 +20,11 @@ STATICDIR = _static
# Static files
ZEROSTATICDEPS
=
$(STATICDIR)
/liso-input-node-graph.svg
# Native plots with LISO files.
ZEROLISODEPS
=
$(
STATIC
DIR)
/liso-two-noises.svg
ZEROLISODEPS
=
$(
BUILD
DIR)
/liso-two-noises.svg
# Native/LISO script comparisons.
ZEROLISOCOMPAREDEPS
=
$(
STATIC
DIR)
/liso-compare-response.svg
ZEROLISOCOMPAREDEPS
=
$(
BUILD
DIR)
/liso-compare-response.svg
# CLI example plots.
CLIOPAMPGAINDEP
=
$(
STATIC
DIR)
/cli-opamp-gain.svg
CLIOPAMPGAINDEP
=
$(
BUILD
DIR)
/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.
$(
STATIC
DIR)/liso-two-noises.svg
:
$(
BUILD
DIR)/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.
$(
STATIC
DIR)/%.svg
:
$(STATICDIR)/liso-compare/%.fil
$(
BUILD
DIR)/%.svg
:
$(STATICDIR)/liso-compare/%.fil
@
echo
"Generating
$@
from
$<
"
zero liso
$<
--compare
--no-plot
--save-figure
$@
...
...
docs/cli/library.rst
View file @
196c9425
...
...
@@ -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
-----------------
...
...
docs/cli/liso.rst
View file @
196c9425
...
...
@@ -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``:
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment