doc updates (formatting)
This commit is contained in:
Stefan Frederik
parent
a303d263e3
commit
541ced0fdf
|
|
@ -39,11 +39,14 @@ p{padding: 15px 30px 10px;}
|
|||
## fetch the repository with git:
|
||||
git clone git://opencircuitdesign.com/open_pdks
|
||||
cd open_pdks
|
||||
## configure the build, a --prefix option can be given to install in a different place,
|
||||
## by default after installation a /usr/local/share/pdk directory is created if no --prefix is provided.
|
||||
## Below line for example requests installation in my home directory (/home/schippes/share/pdk)
|
||||
## configure the build, a --prefix option can be given to install
|
||||
## in a different place, by default after installation a
|
||||
## /usr/local/share/pdk directory is created if no --prefix is provided.
|
||||
## Below line for example requests installation in my home directory
|
||||
## (/home/schippes/share/pdk):
|
||||
## ./configure --enable-sky130-pdk --prefix=/home/schippes
|
||||
## Do the following steps one at a time and ensure no errors are reported after each step.
|
||||
## Do the following steps one at a time and ensure no errors are
|
||||
## reported after each step.
|
||||
./configure --enable-sky130-pdk
|
||||
make
|
||||
make install </pre><br>
|
||||
|
|
@ -72,7 +75,7 @@ xschem
|
|||
You can descend into the example circuits on the left by clicking the symbols (they will turn to grey
|
||||
meaning they are selected) and press the <kbd>e</kbd> key or by menu <kbd>Edit->Push schematic</kbd>.
|
||||
You can return to the parent level by pressing <kbd>Ctrl-e</kbd> or by menu <kbd>Edit->Pop</kbd>.
|
||||
<br><img src="tutorial_xschem_sky130_01.png"><br><br>
|
||||
<br><br><img src="tutorial_xschem_sky130_01.png"><br><br>
|
||||
You can disable the welcome page by commenting the following line in the xschemrc file:<br><br>
|
||||
<pre class="code">
|
||||
set XSCHEM_START_WINDOW {sky130_tests/top.sch} </pre>
|
||||
|
|
@ -101,7 +104,7 @@ set XSCHEM_START_WINDOW {sky130_tests/top.sch} </pre>
|
|||
<p>
|
||||
The best way to quickly set up a simulation with Xschem is to look at some of the provided examples.
|
||||
If you descend into the <kbd>test_inv</kbd> component you see a working circuit ready for simulation.
|
||||
<br><img src="tutorial_xschem_sky130_02.png"><br><br>
|
||||
<br><br><img src="tutorial_xschem_sky130_02.png"><br><br>
|
||||
One line is needed in the spice netlist to load the spice models:
|
||||
</p>
|
||||
<pre class="code">
|
||||
|
|
@ -117,12 +120,12 @@ set XSCHEM_START_WINDOW {sky130_tests/top.sch} </pre>
|
|||
giving simulator commands and options.
|
||||
You place this component by pressing the <kbd>Insert</kbd> or <kbd>i</kbd> key, browsing into the standard xschem
|
||||
<kbd>devices</kbd> directory and placing <kbd>code_shown.sym</kbd> or <kbd>code.sym</kbd> into the schematic.
|
||||
<br><img src="tutorial_xschem_sky130_03.png"><br><br>
|
||||
<br><br><img src="tutorial_xschem_sky130_03.png"><br><br>
|
||||
Once placed in the schematic, you may click the component, press <kbd>q</kbd> to edit its attributes, set the
|
||||
<kbd>Edit attr.</kbd> listbox on the right to <kbd>value</kbd> and enter the simulator commands to run the simulation.
|
||||
You can give a reference name to this component by setting the <kbd>Edit attr.</kbd> listbox to <kbd>name</kbd> and give it
|
||||
a name that will be diplayed in the schematic. (<kbd>COMMANDS2</kbd> in the example).
|
||||
<br><img src="tutorial_xschem_sky130_04.png"><br><br>
|
||||
<br><br><img src="tutorial_xschem_sky130_04.png"><br><br>
|
||||
</p>
|
||||
<p class="important">
|
||||
Note in above commands a <kbd>write test_inv_ngspice.raw</kbd> command. This example runs simulation with both
|
||||
|
|
@ -133,7 +136,7 @@ set XSCHEM_START_WINDOW {sky130_tests/top.sch} </pre>
|
|||
If you select the TT_MODELS component and press <kbd>q</kbd> you see the reference to the PDK top library SPICE file.
|
||||
The path is specified using TCL variables that have been generated by xschem when the pdk installation was looked up.
|
||||
This allows to have portable schematics, no absolute path is hardcoded in the schematic files.
|
||||
<br><img src="tutorial_xschem_sky130_05.png"><br><br>
|
||||
<br><br><img src="tutorial_xschem_sky130_05.png"><br><br>
|
||||
If everything is set up correctly pressing the <kbd>Netlist</kbd> button or hitting the <kbd>n</kbd> key will produce
|
||||
a spice netlist of the circuit. The netlist location is by default set to your home directory:
|
||||
<kbd>~/.xschem/simulations</kbd>
|
||||
|
|
@ -146,9 +149,9 @@ schippes@mazinga:~/x/test_open_pdks$ ls -ltr ~/.xschem/simulations/
|
|||
<p>
|
||||
You can then simulate the circuit. Select the simulator to use by clicking menu
|
||||
<kbd>Simulation->Configure simulators and tools</kbd> and selecting (for this example) <kbd>ngspice</kbd>
|
||||
<br><img src="tutorial_xschem_sky130_06.png"><br><br>
|
||||
<br><br><img src="tutorial_xschem_sky130_06.png"><br><br>
|
||||
Press the <kbd>Simulation</kbd> button and see the ngspice running in a terminal:
|
||||
<br><img src="tutorial_xschem_sky130_07.png"><br><br>
|
||||
<br><br><img src="tutorial_xschem_sky130_07.png"><br><br>
|
||||
</p>
|
||||
<p class="important">
|
||||
The default terminal used by xschem to run the simulator is <kbd>xterm</kbd>. I strongly suggest you to install xterm
|
||||
|
|
@ -165,9 +168,9 @@ schippes@mazinga:~/x/test_open_pdks$ ls -ltr ~/.xschem/simulations/
|
|||
and a waveform reload launcher (<kbd>Simulation->Add waveform reload launcher</kbd>).
|
||||
The launcher has a <kbd>tclcommand</kbd> attribute that loads the simulator data file (<kbd>test_inv.raw</kbd>) and
|
||||
specifies the type of analysis (<kbd>op, dc, ac, tran</kbd>)
|
||||
<br><img src="tutorial_xschem_sky130_08.png"><br><br>
|
||||
<br><br><img src="tutorial_xschem_sky130_08.png"><br><br>
|
||||
See the <a href="graphs.html#graphs">manual</a> for details
|
||||
<br><img src="tutorial_xschem_sky130_09.png"><br><br>
|
||||
<br><br><img src="tutorial_xschem_sky130_09.png"><br><br>
|
||||
</p>
|
||||
<br><br>
|
||||
<!-- end of slide -->
|
||||
|
|
|
|||
|
|
@ -47,7 +47,6 @@
|
|||
<li> <a href="netlisting.html">Netlisting</a></li>
|
||||
<li> <a href="net_probes.html">Net Probes</a></li>
|
||||
<li> <a href="simulation.html">Simulation</a></li>
|
||||
<li> <a href="simulation.html">Simulation</a></li>
|
||||
<li> <a href="graphs.html">Viewing simulation data with XSCHEM</a></li>
|
||||
<li> <a href="developer_info.html">Developer Info, XSCHEM file format specification</a></li>
|
||||
<li> <a href="xschem_remote.html">XSCHEM remote interface specification</a></li>
|
||||
|
|
@ -62,6 +61,8 @@
|
|||
<li><a href="tutorial_ngspice_backannotation.html">Backannotation of Ngspice simulation data into xschem</a></li>
|
||||
<li><a href="tutorial_symgen.html">Use symgen.awk to create symbols from 'djboxsym' compatible text files</a></li>
|
||||
<li><a href="tutorial_gschemtoxschem.html">Translate GEDA gschem/lepton-schematic schematics and symbols to xschem.</a></li>
|
||||
<li><a href="tutorial_xschem_sky130.html">Xschem Google-Skywater 130n (Sky130) process integration</a></li>
|
||||
|
||||
<li><a href="https://xschem.sourceforge.io/stefan/xschem_man/video_tutorials/install_xschem_sky130_and_ngspice.mp4">[Video] Install Xschem, Xschem_sky130, skywater-pdk and ngspice: step by step instructions</a></li>
|
||||
<li><a href="https://xschem.sourceforge.io/stefan/xschem_man/video_tutorials/install_xschem_and_open_pdks.mp4">[Video] Second version, Install Xschem and open_pdks for skywater 130 design</a></li>
|
||||
<li><a href="https://xschem.sourceforge.io/stefan/xschem_man/video_tutorials/editing_and_sim.mp4">[Video] Editing commands and simulation</a></li>
|
||||
|
|
|
|||
Loading…
Reference in New Issue