From 541ced0fdfc06ba03280e5da9cd8b53ed1047177 Mon Sep 17 00:00:00 2001 From: Stefan Frederik Date: Wed, 19 Oct 2022 01:57:29 +0200 Subject: [PATCH] doc updates (formatting) --- doc/xschem_man/tutorial_xschem_sky130.html | 29 ++++++++++++---------- doc/xschem_man/xschem_man.html | 3 ++- 2 files changed, 18 insertions(+), 14 deletions(-) diff --git a/doc/xschem_man/tutorial_xschem_sky130.html b/doc/xschem_man/tutorial_xschem_sky130.html index ca4334ed..85e64d1f 100644 --- a/doc/xschem_man/tutorial_xschem_sky130.html +++ b/doc/xschem_man/tutorial_xschem_sky130.html @@ -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
@@ -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 e key or by menu Edit->Push schematic. You can return to the parent level by pressing Ctrl-e or by menu Edit->Pop. -


+



You can disable the welcome page by commenting the following line in the xschemrc file:

 set XSCHEM_START_WINDOW {sky130_tests/top.sch}
@@ -101,7 +104,7 @@ set XSCHEM_START_WINDOW {sky130_tests/top.sch}

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 test_inv component you see a working circuit ready for simulation. -


+



One line is needed in the spice netlist to load the spice models: 

@@ -117,12 +120,12 @@ set XSCHEM_START_WINDOW {sky130_tests/top.sch}
giving simulator commands and options. You place this component by pressing the Insert or i key, browsing into the standard xschem devices directory and placing code_shown.sym or code.sym into the schematic. -


+



Once placed in the schematic, you may click the component, press q to edit its attributes, set the Edit attr. listbox on the right to value and enter the simulator commands to run the simulation. You can give a reference name to this component by setting the Edit attr. listbox to name and give it a name that will be diplayed in the schematic. (COMMANDS2 in the example). -


+



Note in above commands a write test_inv_ngspice.raw command. This example runs simulation with both @@ -133,7 +136,7 @@ set XSCHEM_START_WINDOW {sky130_tests/top.sch} If you select the TT_MODELS component and press q 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. -


+



If everything is set up correctly pressing the Netlist button or hitting the n key will produce a spice netlist of the circuit. The netlist location is by default set to your home directory: ~/.xschem/simulations @@ -146,9 +149,9 @@ schippes@mazinga:~/x/test_open_pdks$ ls -ltr ~/.xschem/simulations/

You can then simulate the circuit. Select the simulator to use by clicking menu Simulation->Configure simulators and tools and selecting (for this example) ngspice -


+



Press the Simulation button and see the ngspice running in a terminal: -


+



The default terminal used by xschem to run the simulator is xterm. 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 (Simulation->Add waveform reload launcher). The launcher has a tclcommand attribute that loads the simulator data file (test_inv.raw) and specifies the type of analysis (op, dc, ac, tran) -


+



See the manual for details -


+





diff --git a/doc/xschem_man/xschem_man.html b/doc/xschem_man/xschem_man.html index 549865ab..19669e81 100644 --- a/doc/xschem_man/xschem_man.html +++ b/doc/xschem_man/xschem_man.html @@ -47,7 +47,6 @@
  • Netlisting
  • Net Probes
  • Simulation
    • -
  • Simulation
  • Viewing simulation data with XSCHEM
  • Developer Info, XSCHEM file format specification
  • XSCHEM remote interface specification
    • @@ -62,6 +61,8 @@
  • Backannotation of Ngspice simulation data into xschem
  • Use symgen.awk to create symbols from 'djboxsym' compatible text files
  • Translate GEDA gschem/lepton-schematic schematics and symbols to xschem.
    • +
  • Xschem Google-Skywater 130n (Sky130) process integration
    • +
  • [Video] Install Xschem, Xschem_sky130, skywater-pdk and ngspice: step by step instructions
  • [Video] Second version, Install Xschem and open_pdks for skywater 130 design
  • [Video] Editing commands and simulation