vacask-bin 0.3.2.dev2__py3-none-macosx_14_0_arm64.whl

vacask_bin/__init__.py

@@ -0,0 +1,19 @@
+"""Prebuilt VACASK circuit simulator binaries."""
+
+import os
+import sys
+
+_HERE = os.path.dirname(os.path.abspath(__file__))
+_EXE = '.exe' if sys.platform == 'win32' else ''
+
+BIN_DIR = os.path.join(_HERE, 'data', 'bin')
+MOD_DIR = os.path.join(_HERE, 'data', 'lib', 'vacask', 'mod')
+VACASK_CMD = os.path.join(BIN_DIR, 'vacask' + _EXE)
+OPENVAF_CMD = os.path.join(BIN_DIR, 'openvaf-r' + _EXE)
+
+from ._version import __version__
+
+
+def _run_vacask():
+    """Entry point for the 'vacask' console script."""
+    os.execvp(VACASK_CMD, [VACASK_CMD] + sys.argv[1:])

vacask_bin/_version.py

@@ -0,0 +1 @@
+__version__ = "0.3.2.dev2"

vacask_bin/data/lib/vacask/inc/builtins.inc

@@ -0,0 +1,9 @@
+// Default models of builtin devices
+
+model vsource vsource
+model isource isource
+model vcvs vcvs
+model vccs vccs
+model ccvs ccvs
+model cccs cccs 
+model mutual mutual

vacask_bin/data/lib/vacask/python/ng2vc.py

@@ -0,0 +1,114 @@
+#!/usr/bin/python3
+
+# Ngspice to VACASK netlist converter
+# Use as module, i.e. python3 -m ng2vc ...
+# or edit hashbang line and make it executable. 
+
+import sys
+from pprint import pprint
+from ng2vclib.converter import Converter
+from ng2vclib import dfl
+
+if __name__ == "__main__":
+    help="""Ngspice to VACASK netlist converter.")
+Usage: python3 -m ng2vc [<args>] <input file> [<output file>]
+
+If no output file is provided, the converted netlist is printed to 
+the standard output. 
+
+If output file is a relative path it is considered relative to 
+the input file. 
+
+Creates destination directory, if needed. 
+
+Arguments:
+  -h --help           print help
+  -dr --read-depth    maximal depth to which sources are loaded
+                      (infinite by default)
+  -dp --process-depth maximal depth to which sources are processed
+                      (infinite by default)
+  -do --output-depth  maximal depth to which sources are output
+                      (infinite ba default)
+  -sp --sourcepath    add a directory to the sourcepath where
+                      .include and .lib files are found. By default 
+                      sourcepath already contains the current directory. 
+  -am --all-models    dumps all models, not just those that are used
+                      (disabled by default)
+"""
+    ndx = 1
+    fromFile = None
+    toFile = None
+    read_depth = None
+    process_depth = None
+    output_depth = None
+    sourcepath = [ "." ]
+    all_models = False
+    while ndx<len(sys.argv):
+        arg = sys.argv[ndx]
+        if arg[0]=="-":
+            if arg == "--help" or arg == "-h":
+                # Print help and exit
+                print(help)
+                sys.exit(0)
+            elif arg == "-dr" or arg == "--read-depth":
+                if ndx+1>=len(sys.argv):
+                    print("Too few arguments.")
+                    sys.exit(1)
+                ndx += 1
+                read_depth = int(sys.argv[ndx])
+            elif arg == "-dp" or arg == "--process-depth":
+                if ndx+1>=len(sys.argv):
+                    print("Too few arguments.")
+                    sys.exit(1)
+                ndx += 1
+                process_depth = int(sys.argv[ndx])
+            elif arg == "-do" or arg == "--output-depth":
+                if ndx+1>=len(sys.argv):
+                    print("Too few arguments.")
+                    sys.exit(1)
+                ndx += 1
+                output_depth = int(sys.argv[ndx])
+            elif arg == "-sp" or arg == "--sourcepath":
+                if ndx+1>=len(sys.argv):
+                    print("Too few arguments.")
+                    sys.exit(1)
+                ndx += 1
+                sourcepath.append(sys.argv[ndx])
+            elif arg == "-am" or arg == "--all-models":
+                all_models = True
+            else:
+                print("Unknown argument:", arg)
+                print(help)
+                sys.exit(1)
+        else:
+            # Need 1 or 2 more args
+            if ndx+1>len(sys.argv):
+                print("Need input file.")
+                print(help)
+                sys.exit(1)
+            
+            fromFile = arg
+
+            if ndx+2<len(sys.argv):
+                print("Too many arguments.")
+                print(help)
+                sys.exit(1)
+            
+            if ndx+2==len(sys.argv):
+                toFile = sys.argv[ndx+1]
+            else:
+                toFile = None
+            break
+        
+        ndx += 1
+    
+    cfg = dfl.default_config()
+    cfg["sourcepath"] = [ ".", "/home/arpadb/sim/IHP-Open-PDK/ihp-sg13g2/libs.tech/ngspice/models" ]
+    cfg["read_depth"] = read_depth
+    cfg["process_depth"] = process_depth
+    cfg["output_depth"] = output_depth
+    cfg["all_models"] = all_models
+
+    converter = Converter(cfg)
+    converter.convert(fromFile, toFile)
+    

vacask_bin/data/lib/vacask/python/ng2vclib/converter.py

@@ -0,0 +1,146 @@
+from .m_file import FileLoaderMixin
+from .m_masters import MastersMixin
+from .m_output import OutputMixin
+from .m_model import ModelMixin
+from .m_inst_passive import InstancePassiveMixin
+from .m_inst_d import InstanceDMixin
+from .m_inst_n import InstanceNMixin
+from .m_inst_q import InstanceQMixin
+from .m_inst_x import InstanceXMixin
+from .m_devices import DevicesMixin
+from .m_params import ParamsMixin
+
+from . import dfl
+
+import os
+
+class Converter(
+    FileLoaderMixin, 
+    MastersMixin, 
+    OutputMixin, 
+    ModelMixin, 
+    InstancePassiveMixin, 
+    InstanceDMixin, 
+    InstanceNMixin, 
+    InstanceQMixin, 
+    InstanceXMixin, 
+    DevicesMixin, 
+    ParamsMixin
+):
+    """
+    Ngspice to VACASK netlist converter. 
+    *cfg* is the configuration dictionary with the following keys: 
+    * sourcepath .. a list of directories where .include and .lib files
+      are located
+    * type_map .. a list of model types (tuples) with entries
+      * SPICE name (npn, pnp, nmos, pmos, ...)
+      * parameters to add when converting to VACASK
+      * family (used as key in other tables)
+      * remove_level .. True if level parameter should be removed 
+      * remove_version .. True if version parameter should be removed
+    * family_map .. maps tuples of the form
+      * family
+      * level (integer, None is default)
+      * version (string, None is default)
+      into tuples of the form
+      * osdi file to load
+      * module name
+    * default_models .. maps device letters to default models
+      Values are tuples holding
+      * osdi file name
+      * module name
+    * default_model_prefix .. prefix for default model names
+    * as_toplevel .. treat input file as toiplevel netlist. Possible values 
+      * auto .. detect automatically based on .end
+      * no .. treat as toplevel
+      * yes .. do not treat as toplevel
+    * all_models .. if True writes all models to the output, 
+      otherwise ony used models are written
+    * original_case_subckt .. True if you want to keep the original case of 
+      subcircuit definition names 
+    * original_case_model .. True if you want to keep the original case of 
+      model names
+    * original_case_instance .. True if you want to keep the original case of 
+      instance names
+    * read_depth .. include/lib depth up to which the files are read.
+      Default (None) is equivalent to no depth limit. 
+    * process_depth .. include/lib depth up to which the files are processed. 
+      Default (None) is equivalent to no depth limit. 
+    * output_depth .. include/lib depth up to which the files are written
+      to a VACASK netlist. Default (None) is equivalent to no depth limit. 
+    * patch .. a dictionary of patches with file name for key. Files are 
+      matched to this key with the last part of their name. 
+      Values are lists of pairs of the form (old, new). If the old string is 
+      found in the beginning of a line the whole line is replaced with the 
+      new string. 
+    * columns .. number of columns per line
+    
+    The data member dictionary holds the following keys:
+    * title .. unprocessed first line of toplevel file
+    * control .. control block lines
+    * models .. a dictionary of available models, key is subcircuit name
+      where None represents the toplevel circuit. values are dictionaries
+      with model name as key holding tuples of the form
+      holding elements:
+      * builtin .. is it a SPICE builtin
+      * model type (npn, pnp, nmos, pmos, ...)
+      * model family
+      * level (integer)
+      * version (string)
+      * params .. list of (name, value) pairs. 
+    * model_usage .. a dictionary tracking where individual models are used. 
+      Key is a pair of the form (model name, subcircuit where model is defined). 
+      Value is a set of subcircuit names (None for toplevel circuit) 
+      where this model is used. 
+    * default_models_needed .. set of device letters
+    * osdi_loads .. set of files loaded by pre_osdi in control block
+    * subckts .. a dictionary of subcircuit definitions with name for key
+      and values that are tuples holding
+      * terminals .. list of terminals
+      * parameters .. list of (name, value) pairs for parameters
+    * is_toplevel .. True if input file is a toplevel netlist
+    """
+    def __init__(self, cfg=None, indent=4, debug=0):
+        # If no config is given, use default config
+        if cfg is None:
+          cfg = dfl.default_config()
+        self.cfg = cfg
+        self.data = {
+            "control": [], 
+            "models": {}, 
+            "subckts": {}, 
+            "model_usage": {}, 
+            "default_models_needed": set(), 
+            "osdi_loads": set(), 
+        }
+        self.dbgindent = indent
+        self.debug = debug
+    
+    def convert(self, fromFile, toFile=None):
+      _, deck, canonical_file_path = self.read_file(fromFile)
+      self.data["deck"] = deck
+      self.data["canonical_input_path"] = canonical_file_path
+      
+      self.collect_masters()
+
+      out = self.vacask_file()
+
+      if toFile is None:
+        for l in out:
+          print(l)
+      else:
+        if not os.path.isabs(toFile):
+            # Relative path, get directory of input file
+            dest = os.path.join(os.path.dirname(self.data["canonical_input_path"]), toFile)
+        else:
+            dest = toFile
+
+        # Create destination directory
+        destdir = os.path.dirname(dest)
+        os.makedirs(destdir, exist_ok=True)
+
+        with open(dest, "w") as f:
+          for l in out:
+            f.write(l)
+            f.write("\n")
+

vacask_bin/data/lib/vacask/python/ng2vclib/dfl.py

@@ -0,0 +1,118 @@
+
+def default_config(): 
+    """
+    Returns a default configuration. 
+    """
+    return {
+        "signature": "// Converted by ng2vc converter\n", 
+        "sourcepath": [ "." ], 
+        "merge_vector_instance_params": {
+            "q": set(["ic"])
+        }, 
+        "remove_instance_params": {
+            "c": set(["ic"]), 
+            "l": set(["ic"]), 
+            "d": set(["ic", "off"]), 
+            "q" : set(["ic", "off"]), 
+        }, 
+        "merge_vector_model_params": {
+        }, 
+        "remove_model_params": {
+        }, 
+        "type_map": {
+            # name     params             family  remove level  remove version
+            "r":     ( {},                "r",     False,        False), 
+            "res":   ( {},                "r",     False,        False), 
+            "c":     ( {},                "c",     False,        False), 
+            "l":     ( {},                "l",     False,        False), 
+            "d":     ( {},                "d",     False,        False), 
+            "npn":   ( { "type": "1" },   "bjt",   True,         False), 
+            "pnp":   ( { "type": "-1" },  "bjt",   True,         False), 
+            "njf":   ( { "type": "1" },   "jfet",  True,         False), 
+            "pjf":   ( { "type": "-1" },  "jfet",  True,         False), 
+            "nmf":   ( { "type": "1" },   "mes",   True,         False), 
+            "pmf":   ( { "type": "-1" },  "mes",   True,         False), 
+            "nhfet": ( { "type": "1" },   "hemt",  True,         False), 
+            "phfet": ( { "type": "-1" },  "hemt",  True,         False), 
+            "nmos":  ( { "type": "1" },   "mos",   True,         True), 
+            "pmos":  ( { "type": "-1" },  "mos",   True,         True), 
+            "nsoi":  ( { "type": "1" },   "soi",   True,         True), 
+            "psoi":  ( { "type": "-1" },  "soi",   True,         True), 
+        }, 
+        "family_map": {
+            # family, level, version     file                    module          params
+            ("r",     None,  None):    ( "spice/resistor.osdi",  "sp_resistor",  {} ), 
+            ("c",     None,  None):    ( "spice/capacitor.osdi", "sp_capacitor", {} ), 
+            ("l",     None,  None):    ( "spice/inductor.osdi",  "sp_inductor",  {} ), 
+            
+            ("d",     None, None):     ( "spice/diode.osdi",     "sp_diode",     {} ), 
+            ("d",     1,    None):     ( "spice/diode.osdi",     "sp_diode",     {} ), 
+            ("d",     3,    None):     ( "spice/diode.osdi",     "sp_diode",     {} ), 
+
+            ("bjt",   None, None):     ( "spice/bjt.osdi",       "sp_bjt",       {} ), 
+            ("bjt",   1,    None):     ( "spice/bjt.osdi",       "sp_bjt",       {} ), 
+            ("bjt",   4,    None):     ( "spice/vbic.osdi",      "sp_vbic",      {} ), 
+            ("bjt",   9,    None):     ( "spice/vbic.osdi",      "sp_vbic",      {} ), 
+            
+            ("jfet",  None, None):     ( "spice/jfet1.osdi",     "sp_jfet1",     {} ), 
+            ("jfet",  1,    None):     ( "spice/jfet1.osdi",     "sp_jfet1",     {} ), 
+            ("jfet",  2,    None):     ( "spice/jfet2.osdi",     "sp_jfet2",     {} ), 
+            
+            ("mes",   None, None):     ( "spice/mes1.osdi",      "sp_mes1",      {} ), 
+            ("mes",   1,    None):     ( "spice/mes1.osdi",      "sp_mes1",      {} ), 
+
+            ("mos",   None, None):     ( "spice/mos1.osdi",      "sp_mos1",      {} ), 
+            ("mos",   1,    None):     ( "spice/mos1.osdi",      "sp_mos1",      {} ), 
+            ("mos",   2,    None):     ( "spice/mos2.osdi",      "sp_mos2",      {} ), 
+            ("mos",   3,    None):     ( "spice/mos3.osdi",      "sp_mos3",      {} ), 
+            ("mos",   6,    None):     ( "spice/mos6.osdi",      "sp_mos6",      {} ), 
+            ("mos",   9,    None):     ( "spice/mos9.osdi",      "sp_mos9",      {} ), 
+            
+            ("mos",   8,    None):     ( "spice/bsim3v3.osdi",  "sp_bsim3v3",    {} ), 
+            ("mos",   8,    "3.3"):    ( "spice/bsim3v3.osdi",  "sp_bsim3v3",    {} ), 
+            ("mos",   8,    "3.3.0"):  ( "spice/bsim3v3.osdi",  "sp_bsim3v3",    {} ), 
+            ("mos",   8,    "3.2"):    ( "spice/bsim3v2.osdi",  "sp_bsim3v2",    { "version": '"3.2"'   } ), 
+            ("mos",   8,    "3.20"):   ( "spice/bsim3v2.osdi",  "sp_bsim3v2",    { "version": '"3.20"'  } ), 
+            ("mos",   8,    "3.2.2"):  ( "spice/bsim3v2.osdi",  "sp_bsim3v2",    { "version": '"3.2.2"' } ), 
+            ("mos",   8,    "3.22"):   ( "spice/bsim3v2.osdi",  "sp_bsim3v2",    { "version": '"3.22"'  } ), 
+            ("mos",   8,    "3.2.3"):  ( "spice/bsim3v2.osdi",  "sp_bsim3v2",    { "version": '"3.2.3"' } ), 
+            ("mos",   8,    "3.23"):   ( "spice/bsim3v2.osdi",  "sp_bsim3v2",    { "version": '"3.23"'  } ), 
+            ("mos",   8,    "3.2.4"):  ( "spice/bsim3v2.osdi",  "sp_bsim3v2",    { "version": '"3.2.4"' } ), 
+            ("mos",   8,    "3.24"):   ( "spice/bsim3v2.osdi",  "sp_bsim3v2",    { "version": '"3.24"'  } ), 
+            ("mos",   8,    "3.1"):    ( "spice/bsim3v1.osdi",  "sp_bsim3v1",    {} ), 
+            ("mos",   8,    "3.0"):    ( "spice/bsim3v3.osdi",  "sp_bsim3v0",    {} ), 
+            
+            ("mos",   49,   None):     ( "spice/bsim3v3.osdi",   "sp_bsim3v3",   {} ), 
+            ("mos",   49,   "3.3"):    ( "spice/bsim3v3.osdi",   "sp_bsim3v3",   {} ), 
+            ("mos",   49,   "3.3.0"):  ( "spice/bsim3v3.osdi",   "sp_bsim3v3",   {} ), 
+            ("mos",   49,   "3.2"):    ( "spice/bsim3v2.osdi",   "sp_bsim3v2",   { "version": '"3.2"'   } ), 
+            ("mos",   49,   "3.20"):   ( "spice/bsim3v2.osdi",   "sp_bsim3v2",   { "version": '"3.20"'  } ), 
+            ("mos",   49,   "3.2.2"):  ( "spice/bsim3v2.osdi",   "sp_bsim3v2",   { "version": '"3.2.2"' } ), 
+            ("mos",   49,   "3.22"):   ( "spice/bsim3v2.osdi",   "sp_bsim3v2",   { "version": '"3.22"'  } ), 
+            ("mos",   49,   "3.2.3"):  ( "spice/bsim3v2.osdi",   "sp_bsim3v2",   { "version": '"3.2.3"' } ), 
+            ("mos",   49,   "3.23"):   ( "spice/bsim3v2.osdi",   "sp_bsim3v2",   { "version": '"3.23"'  } ), 
+            ("mos",   49,   "3.2.4"):  ( "spice/bsim3v2.osdi",   "sp_bsim3v2",   { "version": '"3.2.4"' } ), 
+            ("mos",   49,   "3.24"):   ( "spice/bsim3v2.osdi",   "sp_bsim3v2",   { "version": '"3.24"'  } ), 
+            ("mos",   49,   "3.1"):    ( "spice/bsim3v1.osdi",   "sp_bsim3v1",   {} ), 
+            ("mos",   49,   "3.0"):    ( "spice/bsim3v0.osdi",   "sp_bsim3v0",   {} ), 
+        }, 
+        "all_models": False, 
+        "default_models": {
+            # letter   osdi file           module
+            "r": ( "spice/resistor.osdi",  "sp_resistor" ), 
+            "c": ( "spice/capacitor.osdi", "sp_capacitor" ), 
+            "l": ( "spice/inductor.osdi",  "sp_inductor" ), 
+        }, 
+        # Identify (graft_flag=False) or add (graft_flag=True) 
+        # multiplier in definition of a subcircuit
+        "subckt_multiplier": {
+            # "subckt_name": [ "multiplier_name", graft_flag ]
+        },
+        "default_model_prefix": "defmod_", 
+        "as_toplevel": "auto", 
+        "read_depth": None,    # Fully recursive
+        "process_depth": None, # Fully recursive
+        "output_depth": None,  # Fully recursive
+        "patch": {}, 
+        "columns": 80, 
+    }

vacask_bin/data/lib/vacask/python/ng2vclib/exc.py

@@ -0,0 +1,10 @@
+from .generators import format_history
+
+# Define out own exception
+class ConverterError(Exception):
+    def __init__(self, message, history=None, lineno=None):
+        if history is not None:
+            txt = format_history(history, lineno)+"\n  "+message
+        else:
+            txt = message
+        super().__init__(txt)