SLiCAP MATLAB documentation

Announcement

Development and support for the MATLAB version of SLiCAP will end in 2021. Users are kindly requested to migrate (and contribute) to SLiCAP_python.

• SLiCAP_python is written in python and maxima CAS.
• SLiCAP_python is fully compatible with Jupyter notebooks.
• SLiCAP_python performs faster than the MATLAB version of SLiCAP.

Version 0.6 is the last release of SLiCAP written in MATLAB code. This is because the core of SLiCAP is written in MuPAD code, which cannot longer be maintained because The Mathworks removed the MuPAD notebook functionality. The alternative of using solely MATLAB code and MATLAB live scripts has been explored but rejected because of its extremely slow performance.

The MATLAB version of SLiCAP will be replaced with an open source version written in Python. It runs on MSwindows, Linux and MacOS and uses both Sympy and Maxima CAS as underlying symbolic math cores. It performs faster than the current version of SLiCAP. It also runs from within Jupyter notebooks, which are very attractive alternatives for MATLAB live scripts.

The open source version can be downloaded from: https://github.com/Lenty/SLiCAP_python.

For more information please visit https://www.analog-electronics.eu/slicap/SLiCAP_python/slicap.html.

SLiCAP MATLAB

License

SLiCAP MATLAB is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License. Based on a work at: https://www.analog-electronics.eu/slicap/SLiCAP_MuPAD/slicap.html

Contents

• SLiCAP Introduction
  • What it is and why you should use it
    • Benefits
    • Features
    • Capabilities
    • Technology
  • Way of working
• SLiCAP tutorials
  • My first RC network
  • Work with parameters
• Download, install and configure SLiCAP
  • Download and Install SLiCAP
    • Install SLiCAP
    • File extensions
    • Use metric prefixes
• Initialize a SLiCAP project
  • Configure SLiCAP options
    • SLiCAPsettings.mu
    • MathJax
    • Digits for calculation
    • Digits for displaying
    • Global parameters
    • Path settings
  • Way of working
  • Getting Help
  • Schematic capture
    • LTspice
    • Gschem
    • Lepton-eda
    • Display schematics on html pages
    • Inkscape .svg editor
• Define a circuit
  • Create a circuit netlist
    • Differences between SPICE and SLiCAP netlist
    • Automatic determination of the netlister
    • Force the use of a netlister
  • Check the netlist and build the matrices
  • Library files
• Work with parameters
  • Get all circuit parameters
  • Get all parameter definitions
  • Assign a definition to a parameter
  • Get the definition or value of a parameter
  • Assign definitions to multiple parameters
  • Delete a parameter definition
• Parameter stepping
  • Define the step method
  • Define the step variable(s)
    • Linear, log and list stepping
    • Array stepping
  • Define the step values
    • Linear and logarithmic stepping
    • Stepping through a list of values
    • Array stepping
  • Enable or disable parameter stepping
  • Plot parameters against each other
    • Example parameter plot
    • Example using built-in parameter plot function
• Define an instruction
  • Simulation type
  • Gain type
  • Signal source
  • Detector
  • Loop gain reference
  • Data type
• Execute an instruction
  • Execution results
    • Data type MATRIX
    • Data type LAPLACE
    • Data type SOLVE
    • Data type NUMER
    • Data type DENOM
    • Data type IMPULSE
    • Data type STEP
    • Data type TIME
    • Data type POLES
    • Data type ZEROS
    • Data type PZ
    • Data type NOISE
    • Data type DC
    • Data type DCVAR
    • Data type DCSOLVE
• Work with the results
  • List poles and zeros
• Design of dynamic behavior
  • Obtain the coefficients of a Laplace polynomial
  • Obtain the coefficients of a Laplace rational
  • Determine circuit parameters from a prototype transfer
  • Estimate the bandwith and system order of a negative-feedback circuit
  • Calculate the Routh array
• Noise design
  • Correlated double sampling
  • Extract source-referred noise
  • Extract detector-referred noise
  • RMS noise
• Create plots
  • Pole-zero and root-locus plots
  • Frequency domain plots
    • dB magnitude plot
    • Logarithmic magnitude plot
    • Linear magnitude plot
    • Real part plot
    • Imaginary part plot
    • Phase plot
    • Delay plot
  • Polar plots
    • Polar linear magnitude
    • Polar dB magnitude
    • Nyquist plot
  • Time domain plots
  • Noise plots
    • Output noise
    • Input noise
  • Step variable as x-axis variable
  • Goal functions
    • Total detector noise versus step variable
    • Noise Figure versus step variable
    • DC value at detector versus step variable
    • Detector-referred DC variance versus step variable
    • Detector-referred DC standard deviation versus step variable
    • Source-referred DC variance versus step variable
    • Source-referred DC standard deviation versus step variable
• Generate HTML reports
  • HTML site structure
    • Main Index.html
    • Circuit index file
  • Start a new html page
  • Headings
    • H2
    • H3
  • List element data
  • List parameter data
  • Include ASCII file
  • Include netlist
  • Include MATLAB script
  • Include images and plots
    • Images from files
    • MATLAB figures
  • Include tables from CSV files
  • Include Pole-Zero results
  • Include noise results
  • Include text
  • Include expressions
    • Include an in line expression in LaTeX format
    • Include a displayed and numbered equation in LaTeX format
    • Include the MNA matrix equation in LaTeX format
• Schematic capture for SLiCAP
  • LTSpice
    • SPICE directives
  • gSchem
    • Node names
    • SPICE directives
  • SLiCAP library
    • slicap.lib
  • Netlist generation
    • Force the use of a netlister
  • Show gSchem and LTspice schematics in HTML output
• Netlist Syntax
  • Netlist lines
    • Breaking long lines
    • Comment
    • Numbers
    • Expressions
    • Title line
    • .include line
    • .subckt … .ends lines
    • .model line
    • .param line
    • Device definition lines
    • .end line
  • Devices and built-in models
    • C: Capacitor
    • D: Diode
    • E: Voltage-controlled voltage source
    • F: Current-controlled current source
    • G: Voltage-controlled current source
    • H: Current-controlled voltage source
    • I: Independent current source
    • J: Junction FET
    • K: Coupling factor
    • L: Inductor
    • M: 4-terminal MOS
    • N: Nullor
    • O: Operational amplifier
    • Q: 4-terminal BJT
    • R: Resistor
    • T: Ideal transformer
    • V: Independent voltage source
    • W: Gyrator
    • X: Sub circuit call
    • Z: Impedance
• Function reference
  • DCvalue
  • Fourier
  • Help
  • LTspiceNetlist
  • RMSnoise
  • SLiCAPlog
  • checkCircuit
  • checkForUpdate
  • coeffsTransfer
  • coeffsTransfer2html
  • controlled
  • csv2html
  • dataType
  • dc2html
  • dcStd2html
  • dcVar2html
  • defPar
  • defPars
  • delPar
  • delay
  • depVars
  • detector
  • doCDS
  • elementData2html
  • elementValues2html
  • elements
  • eps2pdf
  • eps2svg
  • eqn2html
  • equateCoeffs
  • execute
  • expr2char
  • expr2html
  • fig2html
  • file2html
  • findServoBandwidth
  • funType
  • gainType
  • getCoeffs
  • getElementValues
  • getInoise
  • getOnoise
  • getParValue
  • getStepParams
  • haveInet
  • head2html
  • head3html
  • htmlPage
  • img2html
  • indepVars
  • initProject
  • installSLiCAP
  • lgRef
  • listPZ
  • ltspice2matlab
  • mag
  • makeNetlist
  • matrices2html
  • netlist2html
  • noise2html
  • parDefs
  • params
  • params2html
  • pdf2svg
  • phase
  • phaseMargin
  • plotDelay
  • plotImag
  • plotInoise
  • plotMag
  • plotMagLin
  • plotNyquist
  • plotOnoise
  • plotPZ
  • plotParams
  • plotPhase
  • plotPhaseMargin
  • plotPolarLin
  • plotPolardB
  • plotReal
  • plotTime
  • plotVsStep
  • plotdBmag
  • printElementValues
  • pz2html
  • routh
  • saveTeX
  • script2html
  • simType
  • source
  • stepArray
  • stepList
  • stepMethod
  • stepNum
  • stepOff
  • stepOn
  • stepParams
  • stepStart
  • stepStop
  • stepVar
  • stepVars
  • stophtml
  • text2html
  • updateSLiCAP
• Version info
  • Known issues
  • Release notes
    • Version 0.6:
    • Version 0.5:
    • Version 0.4:
    • Version 0.3:
    • Version 0.2:
    • version 0.1:
• About
  • Motivation
    • Partial automation of circuit engineering
  • Derivation of design equations
    • SLiCAP versus hand calculation
    • SLiCAP versus generic symbolic math tools
  • SLiCAP history
  • About the author