Merge branch 'master' into dev_space

PyLTSpice/raw/raw_read.py

@@ -419,7 +419,7 @@ def __init__(self, raw_filename: str, traces_to_read: Union[str, List[str], Tupl
         i = header.index('Variables:')
         ivar = 0
         for line in header[i + 1:-1]:  # Parse the variable names
-            _, name, var_type = line.lstrip().split('\t')
+            idx, name, var_type = line.lstrip().split('\t')
             if has_axis and ivar == 0:  # If it has an axis, it should be always read
                 if numerical_type == 'real':
                     axis_numerical_type = 'double'

PyLTSpice/simulator.py

@@ -0,0 +1,215 @@
+#!/usr/bin/env python
+# coding=utf-8
+
+# -------------------------------------------------------------------------------
+#    ____        _   _____ ____        _
+#   |  _ \ _   _| | |_   _/ ___| _ __ (_) ___ ___
+#   | |_) | | | | |   | | \___ \| '_ \| |/ __/ _ \
+#   |  __/| |_| | |___| |  ___) | |_) | | (_|  __/
+#   |_|    \__, |_____|_| |____/| .__/|_|\___\___|
+#          |___/                |_|
+#
+# Name:        simulator.py
+# Purpose:     Represents a Simulator tool and it's command line options
+#
+# Author:      Nuno Brum (nuno.brum@gmail.com)
+#
+# Created:     23-12-2016
+# Licence:     refer to the LICENSE file
+# -------------------------------------------------------------------------------
+import sys
+import os
+import subprocess
+import time
+from pathlib import Path
+
+if sys.version_info.major >= 3 and sys.version_info.minor >= 6:
+    clock_function = time.process_time
+
+
+    def run_function(command, timeout=None):
+        result = subprocess.run(command, timeout=timeout)
+        return result.returncode
+else:
+    clock_function = time.clock
+
+
+    def run_function(command, timeout=None):
+        return subprocess.call(command, timeout=timeout)
+
+
+class Simulator(object):
+    """Stores the simulator location and command line options and is responsible for generating netlists and running
+    simulations."""
+
+    ltspice_args = {
+        'alt' : ['-alt'],  # Set solver to Alternate.
+        'ascii'     : ['-ascii'],  # Use ASCII.raw files. Seriously degrades program performance.
+        # 'batch': ['-b <path>'], # Used by run command: Run in batch mode.E.g. "ltspice.exe-b deck.cir" will leave the data infile deck.raw
+        'big'       : ['-big'],  # Start as a maximized window.
+        'encrypt'   : ['-encrypt'],
+        # Encrypt a model library.For 3rd parties wishing to allow people to use libraries without
+        # revealing implementation details. Not used by AnalogDevices models.
+        'fastaccess': ['-FastAccess'],  # Batch conversion of a binary.rawfile to Fast Access format.
+        'FixUpSchematicFonts': ['-FixUpSchematicFonts'],
+                       # Convert the font size field of very old user - authored schematic text to the modern default.
+        'FixUpSymbolFonts': ['-FixUpSymbolFonts'],
+                       # Convert the font size field of very old user - authored symbols to the modern default.
+                       # See Changelog.txt for application hints.
+
+        'ini'       : ['- ini', '<path>'],  # Specify an .ini file to use other than %APPDATA%\LTspice.ini
+        'I'   : ['-I<path>'],  # Specify a path to insert in the symbol and file search paths.
+                                     # Must be the last specified option.
+                                     # No space between "-I" and < path > is allowed.
+        'max'       : ['-max'],  # Synonym for -big
+        'netlist'   : ['-netlist'],  # Batch conversion of a schematic to a netlist.
+        'norm'      : ['-norm'],  # Set solver to Normal.
+        'PCBnetlist': ['-PCBnetlist'],  # Batch conversion of a schematic to a PCB format netlist.
+        #'run'       : ['-Run', '-b', '{path}'],  # Start simulating the schematic opened on the command line without
+        #                                         # pressing the Run button.
+        'SOI'       : ['-SOI'],  # Allow MOSFET's to have up to 7 nodes even in subcircuit expansion.
+        'sync'      : ['-sync'],  # Update component libraries
+        'uninstall' : ['-uninstall'],  # Please don't. Executes one step of the uninstallation process.
+
+    }
+
+    @classmethod
+    def get_default_simulator(cls):
+        if sys.platform == "linux":
+            if os.environ.get('LTSPICEFOLDER') is not None:
+                LTspice_exe = ["wine", os.environ['LTSPICEFOLDER'] + "/XVIIx64.exe"]
+            else:
+                LTspice_exe = ["wine",
+                               os.path.expanduser("~") + "/.wine/drive_c/Program Files/LTC/LTspiceXVII/XVIIx64.exe"]
+            process_name = "XVIIx64.exe"
+        elif sys.platform == "darwin":
+            LTspice_exe = ['/Applications/LTspice.app/Contents/MacOS/LTspice']
+            process_name = "XVIIx64"
+        else:  # Windows
+            for exe in (  # Placed in order of preference. The first to be found will be used.
+                    os.path.expanduser(r"~\AppData\Local\Programs\ADI\LTspice\LTspice.exe"),
+                    r"C:\Program Files\ADI\LTspice\LTspice.exe",
+                    r"C:\Program Files\LTC\LTspiceXVII\XVIIx64.exe",
+                    r"C:\Program Files (x86)\LTC\LTspiceIV\scad3.exe",  # Legacy LTspice IV
+            ):
+                if os.path.exists(exe):
+                    print(f"Using LTspice installed in : '{exe}' ")
+                    LTspice_exe = [exe]
+                    _, process_name = os.path.split(exe)
+                    break
+            else:
+                raise FileNotFoundError("A suitable exe file was not found. Please locate the spice simulator "
+                                        "executable and pass it to the SimCommander object by using the 'simulator'"
+                                        "parameter.")
+        return cls(LTspice_exe, process_name)
+
+    @classmethod
+    def create_from(cls, path_to_exe):
+        """
+        Creates a simulator class from a path to the simulator executable
+        :param path_to_exe:
+        :type path_to_exe: pathlib.Path or str
+        :return: a class instance representing the Spice simulator
+        :rtype: Simulator
+        """
+        plib_path_to_exe = Path(path_to_exe)
+        if plib_path_to_exe.exists():
+            if sys.platform == 'darwin':
+                process_name = plib_path_to_exe.stem
+            else:
+                process_name = plib_path_to_exe.name
+            return cls([plib_path_to_exe.as_posix()], process_name)
+        else:
+            raise FileNotFoundError(f"Provided exe file was not found '{path_to_exe}'")
+
+    def __init__(self, spice_exe, process_name):
+        if not isinstance(spice_exe, list):
+            raise TypeError("spice_exe must be a list of strings that can be passed into the subprocess call")
+
+        self.spice_exe = spice_exe
+        self.cmdline_switches = []
+        self.process_name = process_name
+
+    def clear_command_line_switches(self):
+        """Clear all the command line switches added previously"""
+        self.cmdline_switches.clear()
+
+    def add_command_line_switch(self, switch, path=''):
+        """
+        Adds a command line switch to the spice tool command line call. The following options are available for LTSpice:
+
+            * 'alt' : Set solver to Alternate.
+
+            * 'ascii'     : Use ASCII.raw files. Seriously degrades program performance.
+
+            * 'encrypt'   : Encrypt a model library.For 3rd parties wishing to allow people to use libraries without
+            revealing implementation details. Not used by AnalogDevices models.
+
+            * 'fastaccess': Batch conversion of a binary.rawfile to Fast Access format.
+
+            * 'FixUpSchematicFonts'  : Convert the font size field of very old user - authored schematic text to the
+            modern default.
+
+            * 'FixUpSymbolFonts' : Convert the font size field of very old user - authored symbols to the modern
+            default. See Changelog.txt for application hints.
+
+            * 'ini <path>' : Specify an .ini file to use other than %APPDATA%\LTspice.ini
+
+            * 'I<path>' : Specify a path to insert in the symbol and file search paths. Must be the last specified
+            option.
+
+            * 'netlist'   :  Batch conversion of a schematic to a netlist.
+
+            * 'normal'    :  Set solver to Normal.
+
+            * 'PCBnetlist':  Batch conversion of a schematic to a PCB format netlist.
+
+            * 'SOI'       :  Allow MOSFET's to have up to 7 nodes even in subcircuit expansion.
+
+            * 'sync'      : Update component libraries
+
+            * 'uninstall' :  Executes one step of the uninstallation process. Please don't.
+
+
+        :param switch: switch to be added. If the switch is not on the list above, it should be correctly formatted with
+        the preceeding '-' switch
+        :type switch:
+        :param path: path to the file related to the switch being given.
+        :type path: str, optional
+        :return:
+        :rtype:
+        """
+        if switch in self.ltspice_args:
+            switches = self.ltspice_args[switch]
+            switches = [switch.replace('{path}', path) for switch in switches]
+            self.cmdline_switches.extend(switches)
+        else:
+            self.cmdline_switches.append(switch)
+            if path is not None:
+                self.cmdline_switches.append(path)
+
+    def run(self, netlist_file, timeout):
+        if sys.platform == 'darwin':
+            cmd_run = self.spice_exe + ['-b'] + [netlist_file] + self.cmdline_switches
+        else:
+            cmd_run = self.spice_exe + ['-Run'] + ['-b'] + [netlist_file] + self.cmdline_switches
+        # start execution
+        return run_function(cmd_run, timeout=timeout)
+
+    def create_netlist(self, circuit_file):
+        # prepare instructions, two stages used to enable edits on the netlist w/o open GUI
+        # see: https://www.mikrocontroller.net/topic/480647?goto=5965300#5965300
+
+        if sys.platform == 'darwin':
+            NotImplementedError("In this platform LTSpice doesn't have netlist generation capabilities")
+        cmd_netlist = self.spice_exe + ['-netlist'] + [circuit_file]
+        return run_function(cmd_netlist)
+
+    def kill_all(self):
+        import psutil
+        for proc in psutil.process_iter():
+            # check whether the process name matches
+
+            if proc.name() == self.process_name:
+                print("killing ltspice", proc.pid)
+                proc.kill()

doc/classes/SpiceCircuit.rst

@@ -0,0 +1,7 @@
+SpiceCircuit
+============
+
+.. autoclass:: PyLTSpice.SpiceEditor.SpiceCircuit
+   :members:
+   :undoc-members:
+   :show-inheritance:

doc/classes/SpiceEditor.rst

@@ -0,0 +1,7 @@
+SpiceEditor
+===========
+
+.. autoclass:: PyLTSpice.SpiceEditor.SpiceEditor
+   :members:
+   :undoc-members:
+   :show-inheritance:

doc/classes/logreader.rst

@@ -0,0 +1,7 @@
+LTSpiceLogReader
+================
+
+.. autoclass:: PyLTSpice.LTSteps.LTSpiceLogReader
+   :members:
+   :undoc-members:
+   :show-inheritance:

doc/classes/trace.rst

@@ -0,0 +1,7 @@
+RawRead Trace
+=============
+
+.. autoclass:: PyLTSpice.raw_classes.Trace
+   :members:
+   :undoc-members:
+   :show-inheritance:

doc/classes/write_trace.rst

@@ -0,0 +1,7 @@
+RawWrite Trace
+==============
+
+.. autoclass:: PyLTSpice.raw_write.Trace
+   :members:
+   :undoc-members:
+   :show-inheritance: