LTspice

Class used interfacing with LTSpice.

class spicelib.simulators.ltspice_simulator.LTspice

Bases: Simulator

Stores the simulator location and command line options and is responsible for generating netlists and running simulations.

classmethod create_netlist(circuit_file, cmd_line_switches=None, timeout=None, stdout=None, stderr=None, cwd=None, exe_log=False)

Create a netlist out of the circuit file

Parameters:

• circuit_file (str | Path) – path to the circuit file

• cmd_line_switches (list | None) – additional command line options. Best to have been validated by valid_switch(), defaults to None

• timeout (float | None) – If timeout is given, and the process takes too long, a TimeoutExpired exception will be raised, defaults to None

• stdout (_FILE, optional) – control redirection of the command’s stdout. Valid values are None, subprocess.PIPE, subprocess.DEVNULL, an existing file descriptor (a positive integer), and an existing file object with a valid file descriptor. With the default settings of None, no redirection will occur. Also see exe_log for a simpler form of control.

• stderr (_FILE, optional) – Like stdout, but affecting the command’s error output. Also see exe_log for a simpler form of control.

• cwd (str | Path | None) – The current working directory to run the command in. If None, no change will be done of the working directory. This may not work as wanted when using the simulator under wine.

• exe_log (bool) – If True, stdout and stderr will be ignored, and the simulator’s execution console messages will be written to a log file (named …exe.log) instead of console. This is especially useful when running under wine or when running simultaneous tasks.

Raises:

• NotImplementedError – when the requested execution is not possible on this platform.

• RuntimeError – when the netlist cannot be created

Returns:

path to the netlist produced

Return type:

Path

process_name: str

the name of the process in the task manager

classmethod run(netlist_file, cmd_line_switches=None, timeout=None, stdout=None, stderr=None, cwd=None, exe_log=False)

Executes a LTspice simulation run.

A raw file and a log file will be generated, with the same name as the netlist file, but with .raw and .log extension.

Parameters:

• netlist_file (str | Path) – path to the netlist file

• cmd_line_switches (list | None) – additional command line options. Best to have been validated by valid_switch(), defaults to None

• timeout (float | None) – If timeout is given, and the process takes too long, a TimeoutExpired exception will be raised, defaults to None

• stdout (_FILE, optional) – control redirection of the command’s stdout. Valid values are None, subprocess.PIPE, subprocess.DEVNULL, an existing file descriptor (a positive integer), and an existing file object with a valid file descriptor. With the default settings of None, no redirection will occur. Also see exe_log for a simpler form of control.

• stderr (_FILE, optional) – Like stdout, but affecting the command’s error output. Also see exe_log for a simpler form of control.

• cwd (str | Path | None) – The current working directory to run the command in. If None, no change will be done of the working directory. This may not work as wanted when using the simulator under wine.

• exe_log (bool) – If True, stdout and stderr will be ignored, and the simulator’s execution console messages will be written to a log file (named …exe.log) instead of console. This is especially useful when running under wine or when running simultaneous tasks.

Raises:

• SpiceSimulatorError – when the executable is not found.

• NotImplementedError – when the requested execution is not possible on this platform.

Returns:

return code from the process

Return type:

int

spice_exe: list[str]

The executable. If using a loader (like wine), make sure that the last in the array is the real simulator.

classmethod using_macos_native_sim()

Tells if the simulator used is the macOS native LTspice

Returns:

True if the macOS native LTspice is used, False otherwise (will also return False on Windows or Linux)

Return type:

bool

classmethod valid_switch(switch, path='')

Validates a command line switch. The following options are available for Windows/wine 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.

• -PCBnetlistBatch: 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

The following parameters will already be filled in by spicelib, and cannot be set:

• -Run: Start simulating the schematic opened on the command line without pressing the Run button.

• -b: Run in batch mode.

macOS native LTspice accepts no command line switches (yet), use it under wine for full support.

Parameters:

• switch (str) – switch to be added.

• path (str) – path to the file related to the switch being given.

Returns:

Nothing

Return type:

list