path: root/readme.org

#+TITLE: Readme
* Overview

Extends org-babel capabilities to support spice simulations using
ngspice. Simulations are executed using an interactive ngspice process
running in emacs. The running ngspice process can be used to
manipulate the simulation results directly or spread a simulation into
multiple src blocks.

Spice source blocks are interpreted as circuit descriptions until an
'.end' line is encountered. After that a control part may follow
(surrounded by '.control' and '.endc' lines). If there is no '.end'
line all of the src block is interpreted as a control block!

* Installation

Add ~ob-spice.el~ to your load-path and add ~(spice . t)~ to to your
~org-babel-load-languages~ list.

* Examples
** Load a circuit for later simulation
#+BEGIN_SRC org
,#+BEGIN_SRC spice :results output
,* RC
r1 1 0 10k
c1 1 0 1p
.IC V(1)=1
.tran 1n 0.1u
.end
,#+END_SRC

,#+RESULTS:
: Circuit: * rc
#+END_SRC
** Execute some stuff
#+BEGIN_SRC org
,#+BEGIN_SRC spice
echo "Hello world"
,#+END_SRC

,#+RESULTS:
: Hello world
#+END_SRC
#+BEGIN_SRC org
,#+BEGIN_SRC spice
echo "0,1,2,3"
,#+END_SRC

,#+RESULTS:
| 0 | 1 | 2 | 3 |
#+END_SRC

** Plot some voltages and return png
#+BEGIN_SRC org
,#+BEGIN_SRC spice :var file="/tmp/simpleplot" :results file
,*RC circuit
r1 1 0 10k
c1 1 0 1p

.IC V(1)=1
.tran 1n 0.1u
.end

.control
run
set gnuplot_terminal=png
gnuplot $file v(1)
.endc
,#+END_SRC

,#+RESULTS:
[[file:/tmp/simpleplot.png]]
#+END_SRC

** Do measurements and return results
#+BEGIN_SRC org
,#+BEGIN_SRC spice :results value
,*Time Constant Measurement
r1 1 0 10k
c1 1 0 1p

.IC V(1)=1
.tran 1n 0.1u
.print tran v(1)
.end

.control
run
meas tran value_at_tau find V(1) at=1e-8
meas tran value_at_five_tau find V(1) at=5e-8
echo $&value_at_tau ,$&value_at_five_tau
.endc
,#+END_SRC

,#+RESULTS:
| 0.36798 | 0.00671732 |
#+END_SRC

** Write simulation data to file and return file name

A gnuplot block is called on the result of the spice block using the
~:post~ header argument. This allows the usage of all gnuplot options instead
of the limited ngspice subset. Note the use of square brackets in the
~:post~ header argument.

#+BEGIN_SRC org
,#+NAME: plot_stuff
,#+BEGIN_SRC gnuplot :var data="ignored"
reset
plot data u 1:2 w l ls 1
,#+END_SRC

,#+BEGIN_SRC spice :var file="/tmp/rc" :post plot_stuff[:file /tmp/rc.png](data=*this*) :results file
,*RC circuit
r1 1 0 10k
c1 1 0 1p
.IC V(1)=1
.tran 1n 0.1u
.end
.control
run
wrdata $file v(1)
.endc
,#+END_SRC

,#+RESULTS:
[[file:/tmp/rc.png]]
#+END_SRC

** Use calculation results of other src blocks as parameters

Parameters calculated in any language can be included as variables.

#+BEGIN_SRC org
,#+NAME: dim1_params
,#+BEGIN_SRC ruby
[7.326e-06,1.321e-05,5.4117e-06,2.344e-05,2.4e-06, 100.0]
,#+END_SRC

,#+NAME: dim1_plot
,#+BEGIN_SRC gnuplot :var data="x"
set terminal pngcairo size 640,300 enhanced
set format y "%.0s%cV"
set format x "%.0s%cs"
set xrange [190e-9:260e-9]
set yrange [-5e-3:11e-3]
set grid
set ytics 5e-3
set xlabel "t"
plot data using 1:2 w l ls 2 t "V_{out}"
,#+END_SRC

,#+NAME: dim1
,#+BEGIN_SRC spice :eval never
,* DAC.asc
.model mosp pmos level=8 version=3.3.0 
M1 0 VDD N005 N005 mosp l=$dim[5] w=$dim[4]
M2 VOUT VCTRL N005 N005 mosp l=$dim[5] w=$dim[4]
M4 N003 N002 VDD VDD mosp l=$dim[3] w=$dim[2]
M3 N002 N002 VDD VDD mosp l=$dim[3] w=$dim[2]
M5 N005 N004 N003 N003 mosp l=$dim[3] w=$dim[2]
M6 N004 N004 N002 N002 mosp l=$dim[3] w=$dim[2]
RL VOUT 0 $dim[6]
CL VOUT 0 10p
VDD VDD 0 5
IREF N004 0 7.3u
V1 VBIAS 0 2.5
V2 VCTRL 0 PULSE(0 5 0 1n 1n 200n 420n)
VM VDD N001 0
.tran 1n 300n 190n
.end
,#+END_SRC

,#+HEADER: :post dim1_plot[:file /tmp/dim1.png](data=*this*) :noweb yes
,#+BEGIN_SRC spice :session test :var file="/tmp/dim1" dim=dim1_params :results file
<<dim1>>
run
wrdata $file v(vout)
,#+END_SRC

,#+RESULTS:
[[file:/tmp/dim1.png]]
#+END_SRC

* Current supported special Flags
  - ~:dir~: Working directory to run the src block in. Default is the
    value of ~default-directory~.
* Variable handling

Variables can either be strings or arrays represented by ~$var~ or
~$var[0]~. Variables in the circuit part are replaced with their value
using a regex search. This supports only positive indexes at the
moment. Variables in the control part are handled by setting their
value in the spice session and letting spice figure out their value on
its own. Vector/Array indexing in /ngspice/ starts with index 1 not 0!
To generate file names a ~$file~ variable can be set and file extensions
can be appended using this notation:
#+BEGIN_SRC org
,#+BEGIN_SRC spice :var file="result/test1" :results output
echo $file\.txt
echo $file\.png
,#+END_SRC

,#+RESULTS:
: result/test1.txt
: result/test1.png
#+END_SRC
* Result type handling

If RESULT-TYPE equals ~output~ return all outputs, if it equals ~value~
return only value of last statement.\\
If the last command was any of ~wrdata~, ~write~ or ~gnuplot~ using
result-type ~value~ returns the corresponding filename.\\
To output multiple values as a table use either " ," or "\," as
separator or quote the whole echo string and use ",".

#+BEGIN_SRC org
,#+BEGIN_SRC spice :var x=6.13 :exports both
echo 1 ,$x ,abc
,#+END_SRC

,#+RESULTS:
| 1 | 6.13 | abc |

,#+BEGIN_SRC spice :var x=6.13 :exports both
echo 1\,$x\,abc
,#+END_SRC

,#+RESULTS:
| 1 | 6.13 | abc |

,#+BEGIN_SRC spice :var x=6.13 :exports both
echo "1,$x,abc"
,#+END_SRC

,#+RESULTS:
| 1 | 6.13 | abc |
#+END_SRC