SLiCAP 3.3__tar.gz

slicap-3.3/MANIFEST.in

@@ -0,0 +1,2 @@
+recursive-include SLiCAP/docs *
+recursive-include SLiCAP/files/ *

slicap-3.3/PKG-INFO

@@ -0,0 +1,116 @@
+Metadata-Version: 2.2
+Name: SLiCAP
+Version: 3.3
+Summary: SLiCAP: more than SYMBOLIC SPICE
+Home-page: https://github.com/SLiCAP/SLiCAP_python/
+Author: Anton Montagne
+Author-email: Anton Montagne <anton@montagne.nl>
+License: MIT
+Project-URL: Homepage, https://slicap.github.io/SLiCAP_python/
+Project-URL: Issues, https://github.com/SLiCAP/SLiCAP_python
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Dynamic: author
+Dynamic: home-page
+Dynamic: license
+Dynamic: requires-python
+
+# SLiCAP: more than SYMBOLIC SPICE
+
+## What it is
+- SLiCAP is an acronym for: **S** ymbolic **Li** near **C** ircuit **A** nalysis **P** rogram
+- SliCAP is a tool for **algorithm-based analog design automation**
+- SLiCAP is intended for setting up and solving **design equations** of electronic circuits
+- SLiCAP is a an **open source** application written in Python
+- SLiCAP is part of the tool set for teaching [Structured Electronics Design](https://analog-electronics.tudelft.nl) at the Delft University of Technology
+
+## Why you should use it
+- SLiCAP facilitates analog design automation and stepwise, hierachically-structured, analog design 
+- SLiCAP lets you relate circuit component and device geometry requirements to system performance requirements
+- SLiCAP makes complex symbolic circuit analysis doable
+- SLiCAP speeds up the circuit design process
+- SLiCAP integrates documentation and design ("one-click" update of HTML or PDF design reports)
+- SLiCAP facilitates design education and knowledge building
+
+## Features
+- Accepts SPICE-like netlists as input and provides netlist generation from, amongst others, Kicad and LTspice schematic files.
+- Facilitates concurrent design and documentation
+- Supports and facilitates structured analog design
+
+## Capabilities
+- Conversion of hierarchically structured SPICE netlist into a mixed symbolic/numeric matrix equation
+- Symbolic and numeric noise analysis
+- Symbolic and numeric noise integration over frequency
+- Symbolic and numeric determination of transfer functions and polynomial coefficients of transfer functions
+- Symbolic and numeric inverse Laplace Transform
+- Symbolic and numeric determination of network solutions
+- Symbolic and numeric pole-zero analysis (symbolic pole-zero analysis for low-order systems only)
+- Symbolic and numeric Routh array
+- Order estimation of feedback circuits (numeric only)
+- Root-locus analysis with an arbitrarily selected circuit parameter as root locus variable
+- Symbolic and numeric DC and DC variance analysis for determination of budgets for resistor tolerances, offset, temperature effects, matching and tracking
+- Symbolic and numeric derivation and solution of design equations for bandwidh, frequency response, noise, dc variance, and temperature stability
+
+## Setting up SLiCAP
+1. Intall Python 3.12+ with the packages listed in requirements.txt (for MSwindows Anaconda installation is preferred)
+2. Download or clone the SLiCAP archive from github
+3. Extract it in some directory
+4. Open a terminal (or an Anaconda terminal if you run python from Anaconda) in the directory with setup.py
+5. Enter: 
+
+       python -m pip install .
+   
+   Don't forget the dot!
+
+## Addidional software
+- SLiCAP can generate netlists from schematic files from:
+  - Kicad (all platforms, preferred!)
+  - LTspice (MSWindows: install LTspice on the system drive, Linux and MacOS: use MSwindows version and wine)
+  - gschem (MSWindows: install gschem and its netlister on the system drive, Linux and MacOS: use lepton-eda)
+  - lepton-eda (Linux and MacOS, MSWindows: use gSchem for windows)
+- Inkscape is used to:
+  - convert the page size of SVG images of schematic files generates with Kicad, lepton-eda, or gSchem to the image size
+  - convert the above svg images to pdf (for use in LaTeX).
+
+Preferred for all platforms is to install or upgrade to the latest version of Kicad, and install Inkscape.
+
+## First Run
+
+To verify correct installation of SLiCAP run the example "myFirstRCnetwork.py" in the project folder. This project folder is found in the example folder in the SLiCAP home directory. 
+
+On the first run:
+
+- SLiCAP searches for installed applications:
+  - Kicad,
+  - LTspice
+  - NGspice
+  - gSchem (MSWindows only)
+  - lepton-eda (Linux and MacOS)
+  - Inkscape
+- SLiCAP creates a SLiCAP.ini file in the SLiCAP home directory. This file contains initial setting and commands to start the above applications. It can be edited manually, and when deleted it will be recreated on the next run. Searching for applications on MSWindows may take a while!
+
+On the first run of a project, SLiCAP creates a SLiCAP.ini file in the project folder, each time you run the project this file is updated. If you delete it it will be recreated on the next run.
+
+## Project file locations
+Do not place your project files in the **SLiCAP home directory**: /home/<yourUserName\>/SLiCAP/ (LINUX) or \users\<yourUserName\>\SLiCAP\ (MSWindows). 
+
+This directory contains the libraries, the examples, and the documentation. 
+
+**This directory will be deleted and recreated each time you install SLiCAP.**
+
+## Documentation
+By default, the documentation is placed in /home/<yourUserName\>/SLiCAP/docs/ (LINUX) or \users\<yourUserName\>\SLiCAP\docs\ (MSWindows). 
+
+Execution of the SLiCAP command:
+
+    >>> Help()
+    
+shows the HTML documentation in your default browser.
+
+## Contributing
+If you want to contribute to the development of SLiCAP, please [Email Us](mailto:anton@montagne.nl).
+
+### Bugs
+In case bugs are found, please report them to the 'Issues' page.

slicap-3.3/README.md

@@ -0,0 +1,97 @@
+# SLiCAP: more than SYMBOLIC SPICE
+
+## What it is
+- SLiCAP is an acronym for: **S** ymbolic **Li** near **C** ircuit **A** nalysis **P** rogram
+- SliCAP is a tool for **algorithm-based analog design automation**
+- SLiCAP is intended for setting up and solving **design equations** of electronic circuits
+- SLiCAP is a an **open source** application written in Python
+- SLiCAP is part of the tool set for teaching [Structured Electronics Design](https://analog-electronics.tudelft.nl) at the Delft University of Technology
+
+## Why you should use it
+- SLiCAP facilitates analog design automation and stepwise, hierachically-structured, analog design 
+- SLiCAP lets you relate circuit component and device geometry requirements to system performance requirements
+- SLiCAP makes complex symbolic circuit analysis doable
+- SLiCAP speeds up the circuit design process
+- SLiCAP integrates documentation and design ("one-click" update of HTML or PDF design reports)
+- SLiCAP facilitates design education and knowledge building
+
+## Features
+- Accepts SPICE-like netlists as input and provides netlist generation from, amongst others, Kicad and LTspice schematic files.
+- Facilitates concurrent design and documentation
+- Supports and facilitates structured analog design
+
+## Capabilities
+- Conversion of hierarchically structured SPICE netlist into a mixed symbolic/numeric matrix equation
+- Symbolic and numeric noise analysis
+- Symbolic and numeric noise integration over frequency
+- Symbolic and numeric determination of transfer functions and polynomial coefficients of transfer functions
+- Symbolic and numeric inverse Laplace Transform
+- Symbolic and numeric determination of network solutions
+- Symbolic and numeric pole-zero analysis (symbolic pole-zero analysis for low-order systems only)
+- Symbolic and numeric Routh array
+- Order estimation of feedback circuits (numeric only)
+- Root-locus analysis with an arbitrarily selected circuit parameter as root locus variable
+- Symbolic and numeric DC and DC variance analysis for determination of budgets for resistor tolerances, offset, temperature effects, matching and tracking
+- Symbolic and numeric derivation and solution of design equations for bandwidh, frequency response, noise, dc variance, and temperature stability
+
+## Setting up SLiCAP
+1. Intall Python 3.12+ with the packages listed in requirements.txt (for MSwindows Anaconda installation is preferred)
+2. Download or clone the SLiCAP archive from github
+3. Extract it in some directory
+4. Open a terminal (or an Anaconda terminal if you run python from Anaconda) in the directory with setup.py
+5. Enter: 
+
+       python -m pip install .
+   
+   Don't forget the dot!
+
+## Addidional software
+- SLiCAP can generate netlists from schematic files from:
+  - Kicad (all platforms, preferred!)
+  - LTspice (MSWindows: install LTspice on the system drive, Linux and MacOS: use MSwindows version and wine)
+  - gschem (MSWindows: install gschem and its netlister on the system drive, Linux and MacOS: use lepton-eda)
+  - lepton-eda (Linux and MacOS, MSWindows: use gSchem for windows)
+- Inkscape is used to:
+  - convert the page size of SVG images of schematic files generates with Kicad, lepton-eda, or gSchem to the image size
+  - convert the above svg images to pdf (for use in LaTeX).
+
+Preferred for all platforms is to install or upgrade to the latest version of Kicad, and install Inkscape.
+
+## First Run
+
+To verify correct installation of SLiCAP run the example "myFirstRCnetwork.py" in the project folder. This project folder is found in the example folder in the SLiCAP home directory. 
+
+On the first run:
+
+- SLiCAP searches for installed applications:
+  - Kicad,
+  - LTspice
+  - NGspice
+  - gSchem (MSWindows only)
+  - lepton-eda (Linux and MacOS)
+  - Inkscape
+- SLiCAP creates a SLiCAP.ini file in the SLiCAP home directory. This file contains initial setting and commands to start the above applications. It can be edited manually, and when deleted it will be recreated on the next run. Searching for applications on MSWindows may take a while!
+
+On the first run of a project, SLiCAP creates a SLiCAP.ini file in the project folder, each time you run the project this file is updated. If you delete it it will be recreated on the next run.
+
+## Project file locations
+Do not place your project files in the **SLiCAP home directory**: /home/<yourUserName\>/SLiCAP/ (LINUX) or \users\<yourUserName\>\SLiCAP\ (MSWindows). 
+
+This directory contains the libraries, the examples, and the documentation. 
+
+**This directory will be deleted and recreated each time you install SLiCAP.**
+
+## Documentation
+By default, the documentation is placed in /home/<yourUserName\>/SLiCAP/docs/ (LINUX) or \users\<yourUserName\>\SLiCAP\docs\ (MSWindows). 
+
+Execution of the SLiCAP command:
+
+    >>> Help()
+    
+shows the HTML documentation in your default browser.
+
+## Contributing
+If you want to contribute to the development of SLiCAP, please [Email Us](mailto:anton@montagne.nl).
+
+### Bugs
+In case bugs are found, please report them to the 'Issues' page.

slicap-3.3/SLiCAP/SLiCAP.py

@@ -0,0 +1,175 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""
+Main module for running SLiCAP from a console or from within a Python IDE.
+
+When working with Jupyter notebooks the main imort module is SLiCAPnotebook.py.
+It will import SLiCAP.py and some extra modules for displaying LaTeX, SVG and
+RST in the Jupyter notebooks.
+"""
+import os
+import webbrowser
+import numpy as np
+import SLiCAP.SLiCAPconfigure as ini
+from datetime import datetime
+from shutil import copy2
+from SLiCAP.SLiCAPyacc import _initializeParser
+from scipy.optimize import newton, fsolve
+from scipy.integrate import quad
+from SLiCAP.SLiCAPdesignData import *
+from SLiCAP.SLiCAPinstruction import instruction
+from SLiCAP.SLiCAPmath import *
+from SLiCAP.SLiCAPplots import *
+from SLiCAP.SLiCAPlatex import *
+from SLiCAP.SLiCAPrst import *
+from SLiCAP.SLiCAPngspice import MOS, ngspice2traces
+from SLiCAP.SLiCAPltspice import runLTspice
+from SLiCAP.SLiCAPshell import *
+from SLiCAP.SLiCAPhtml import *
+from SLiCAP.SLiCAPhtml import _startHTML
+
+# Increase width for display of numpy arrays:
+np.set_printoptions(edgeitems=30, linewidth=1000,
+    formatter=dict(float=lambda x: "%11.4e" % x))
+
+def Help():
+    """
+    Opens the SLiCAP HTML documentation in the default browser.
+    
+    :example:
+    
+    >>> import SLiCAP as sl
+    >>> # Display the SLiCAP HTML help in your default browser:
+    >>> sl.Help()
+    """
+    webbrowser.open_new(ini.doc_path + 'index.html')
+    return
+
+def _copyNotOverwrite(src, dest):
+    """
+    Copies the file 'src' to 'dest' if the latter one does not exist.
+
+    :param src: Name of the source file.
+    :type src: str
+
+    :param dest: Name of the desitination file.
+    :type dest: str
+    """
+    if not os.path.exists(dest):
+        copy2(src, dest)
+    return
+
+def _makeDir(dirName):
+    """
+    Creates the directory 'dirName' if it does not yet exist.
+
+    :param dirName: Name of the ditectory.
+    :type dirName: str
+    """
+
+    if not os.path.exists(dirName):
+        os.makedirs(dirName)
+    return
+
+def initProject(name, notebook=False):
+    """
+    Initializes a SLiCAP project.
+
+    - Copies the directory structure from the templates subdirectory to the
+      project directory in cases it has not yet been created.
+    - Creates index.html in the html directory with the project name in the
+      title bar
+    - Compiles the system libraries
+    - Creates or updates 'SLiCAPconfigure.py' in the project directory
+
+    :param name: Name of the project: appears on the main html index page.
+    :type name: str
+
+    :return:     None
+    :rtype:      NoneType
+
+    :Example:
+
+    >>> import SLiCAP as sl 
+    >>> # At the first run it will create a 'SLiCAP.ini' file in the SLiCAP 
+    >>> # home folder:  '~/SLiCAP/'. 
+    >>> # To this end it searches for installed applications. 
+    >>> # Under MSwindows this may take a while.
+    >>> sl.initProject('my first SLiCAP project')
+    >>> # At the first run this will create a 'SLiCAP.ini' file in the SLiCAP 
+    >>> # project folder:  './'. Once created it will only reset some values.
+    >>> # This function also resets the netlist parser and (re)creates the 
+    >>> # system library objects.
+    >>> sl.ini.dump() 
+    >>> # Prints the SLiCAP global settings obtained from both ini files.
+
+    """
+    # Read the project data from the project configuration file
+    project_config = ini._read_project_config()
+    
+    # Adjust image sizes for notebooks (image font size equals notebook font size)
+    ini.notebook        = notebook
+    if notebook:
+        # These values will not be stored
+        ini.axis_width    = 4
+        ini.axis_height   = 3
+        ini.plot_fontsize = 9
+        ini.line_width    = 1
+    # Define the project title and reset the html pages 
+    ini.project_title                         = name
+    ini.html_page                             = 'index.html'
+    project_config['html']['current_page']    = ini.html_page
+    ini.html_index                            = 'index.html'
+    project_config['html']['current_index']   = ini.html_index
+    ini.html_pages                            = []
+    project_config['html']['pages']           = (',').join(ini.html_pages)
+    ini.html_labels                           = {}
+    project_config['labels']                  = ini.html_labels
+    ini.html_prefix                           = ''
+    project_config['html']['prefix']          = ini.html_prefix
+    ini.project_title                         = name
+    project_config['project']['title']        = ini.project_title
+    ini.last_updated                          = datetime.now().strftime("%Y-%m-%d %H:%M:%S")
+    project_config['project']['last_updated'] = ini.last_updated
+    
+    # Update configuration files
+    ini.main_config, ini.project_config = ini._update_ini_files()
+    # Create the project directory structure, at the first run of initProject()
+    _makeDir(ini.html_path)
+    _makeDir(ini.txt_path)
+    _makeDir(ini.csv_path)
+    _makeDir(ini.img_path)
+    _makeDir(ini.sphinx_path)
+    _makeDir(ini.mathml_path)
+    _makeDir(ini.cir_path)
+    _makeDir(ini.user_lib_path)
+    _makeDir(ini.tex_path)
+    _makeDir(ini.html_path + 'img/')
+    _makeDir(ini.html_path + 'css/')
+    _copyNotOverwrite(ini.install_path + 'SLiCAP/files/html/css/slicap.css', ini.html_path + 'css/slicap.css')
+    _copyNotOverwrite(ini.install_path + 'SLiCAP/files/html/img/Grid.png', ini.html_path + 'css/Grid.png')
+    _copyNotOverwrite(ini.install_path + 'SLiCAP/files/sphinx/make.bat', ini.sphinx_path + 'make.bat')
+    _copyNotOverwrite(ini.install_path + 'SLiCAP/files/sphinx/Makefile', ini.sphinx_path + 'Makefile')
+    _makeDir(ini.sphinx_path + 'SLiCAPdata/')
+    _makeDir(ini.sphinx_path + 'source/')
+    _copyNotOverwrite(ini.install_path + 'SLiCAP/files/sphinx/conf.py', ini.sphinx_path + 'source/conf.py')
+    _copyNotOverwrite(ini.install_path + 'SLiCAP/files/sphinx/index.rst', ini.sphinx_path + 'source/index.rst')
+    _makeDir(ini.sphinx_path + 'source/img/')
+    _copyNotOverwrite(ini.install_path + 'SLiCAP/files/sphinx/img' + '/colorCode.svg', ini.sphinx_path + 'source/img/colorCode.svg')
+    _copyNotOverwrite(ini.install_path + 'SLiCAP/files/sphinx/img' + '/SLiCAP.svg', ini.sphinx_path + 'source/img/SLiCAP.svg')
+    _copyNotOverwrite(ini.install_path + 'SLiCAP/files/sphinx/img' + '/SLiCAP-h1.svg', ini.sphinx_path + 'source/img/SLiCAP-h1.svg')
+    _makeDir(ini.sphinx_path + 'source/_static/')
+    _copyNotOverwrite(ini.install_path + 'SLiCAP/files/sphinx/_static/html_logo.png', ini.sphinx_path + 'source/_static/html_logo.png')
+    _copyNotOverwrite(ini.install_path + 'SLiCAP/files/sphinx/_static/custom.css', ini.sphinx_path + 'source/_static/custom.css')
+    _copyNotOverwrite(ini.install_path + 'SLiCAP/files/sphinx/_static/handsontable.full.min.css', ini.sphinx_path + 'source/_static/handsontable.full.min.css')
+    _copyNotOverwrite(ini.install_path + 'SLiCAP/files/sphinx/_static/handsontable.full.min.js', ini.sphinx_path + 'source/_static/handsontable.full.min.js')
+    _makeDir(ini.sphinx_path + 'source/_templates/')
+    _copyNotOverwrite(ini.install_path + 'SLiCAP/files/sphinx/_templates/layout.html', ini.sphinx_path + 'source/_templates/layout.html')
+    _makeDir(ini.tex_path + 'SLiCAPdata/')
+    _copyNotOverwrite(ini.install_path + 'SLiCAP/files/tex/preambuleSLiCAP.tex', ini.tex_path + 'preambuleSLiCAP.tex')
+    #
+    if not ini.notebook:
+        # Create the HTML project index file
+        _startHTML(name)
+    # Initialize the parser, this will create the libraries and delete all previously defined circuits
+    _initializeParser()