fixed xyce/ngspice path and doc

Author: FabriceSalvaire

PySpice/Spice/NgSpice/Server.py

@@ -79,7 +79,7 @@ class SpiceServer:
 
     def __init__(self, **kwargs):
 
-        self._spice_command = kwargs.get('spice_command', self.SPICE_COMMAND)
+        self._spice_command = kwargs.get('spice_command') or self.SPICE_COMMAND
 
     ##############################################
 

PySpice/Spice/Xyce/Server.py

@@ -31,8 +31,7 @@
 import subprocess
 import tempfile
 
-####################################################################################################
-
+from PySpice.Config import ConfigInstall
 from .RawFile import RawFile
 
 ####################################################################################################
@@ -43,7 +42,7 @@
 
 class XyceServer:
 
-    """This class wraps the execution of xyce and convert the output to a Python data structure.
+    """This class wraps the execution of Xyce and convert the output to a Python data structure.
 
     Example of usage::
 
@@ -52,17 +51,26 @@ class XyceServer:
 
     It returns a :obj:`PySpice.Spice.RawFile` instance.
 
+    Default Xyce path is set in `XyceServer.XYCE_COMMAND`.
+
     """
 
-    _logger = _module_logger.getChild('XyceServer')
+    if ConfigInstall.OS.on_linux:
+        XYCE_COMMAND = 'Xyce'
+    elif ConfigInstall.OS.on_osx:
+        XYCE_COMMAND = 'Xyce'
+    elif ConfigInstall.OS.on_windows:
+        XYCE_COMMAND = 'C:\\Program Files\\Xyce 6.10 OPENSOURCE\\bin\\Xyce.exe'
+    else:
+        raise NotImplementedError
 
-    XYCE_COMMAND = 'Xyce'
+    _logger = _module_logger.getChild('XyceServer')
 
     ##############################################
 
     def __init__(self, **kwargs):
 
-        self._xyce_command = kwargs.get('xyce_command', self.XYCE_COMMAND)
+        self._xyce_command = kwargs.get('xyce_command') or self.XYCE_COMMAND
 
     ##############################################
 

PySpice/Spice/Xyce/Simulation.py

@@ -49,7 +49,7 @@ def __init__(self, circuit, **kwargs):
         super().__init__(circuit, **kwargs)
 
         xyce_command = kwargs.get('xyce_command', None)
-        self._spice_server = XyceServer(spice_command=xyce_command)
+        self._xyce_server = XyceServer(xyce_command=xyce_command)
 
     ##############################################
 
@@ -63,7 +63,7 @@ def _run(self, analysis_method, *args, **kwargs):
 
         super()._run(analysis_method, *args, **kwargs)
 
-        raw_file = self._spice_server(spice_input=str(self))
+        raw_file = self._xyce_server(spice_input=str(self))
         self.reset_analysis()
         raw_file.simulation = self
 

doc/sphinx/source/faq.rst

@@ -92,17 +92,29 @@ and raw parameters using:
 How to set the Ngspice library path ?
 -------------------------------------
 
-If the setting doesn't match your environment, then you have to set manually the attribute
+If the default setting doesn't match your environment, then you have to fix globally the attribute
 :attr:`PySpice.Spice.NgSpice.Shared.NgSpiceShared.LIBRARY_PATH`. Note you have to place a brace pair
-just before the extension, for example "C:\...\ngspice{}.dll".  You can also fix the value of
-:attr:`PySpice.Spice.NgSpice.Shared.NgSpiceShared.NGSPICE_PATH`.
+just before the extension, for example :file:`C:\\...\\ngspice{}.dll`.
 
-How to set the Ngspice path ?
------------------------------
+You can also fix the value of :attr:`PySpice.Spice.NgSpice.Shared.NgSpiceShared.NGSPICE_PATH`.
 
-If the setting doesn't match your environment, then you have to set manually the attribute
-:attr:`PySpice.Spice.Server.SpiceServer.SPICE_COMMAND`. This value can be passed as argument as
-well, see API documentation.
+How to set the Ngspice executable path ?
+----------------------------------------
+
+If the default setting doesn't match your environment, then you can fix globally the Ngspice executable
+path using the attribute :attr:`PySpice.Spice.NgSpice.Server.SpiceServer.SPICE_COMMAND`, you can also
+pass the executable path to the simulator using::
+
+   simulator = circuit.simulator(spice_command='...')
+
+How to set the Xyce path ?
+--------------------------
+
+If the default setting doesn't match your environment, then you can fix globally the Xyce executable
+path using the attribute :attr:`PySpice.Spice.Xyce.Server.XyceServer.XYCE_COMMAND`, you can also
+pass the executable path to the simulator using::
+
+   simulator = circuit.simulator(xyce_command='...')
 
 How to set the simulator ?
 --------------------------

issues/issue-133.py

@@ -33,7 +33,6 @@
 print(str(circuit))
 
 simulator = circuit.simulator(simulator='xyce-serial')
-
 analysis = simulator.operating_point()
 
 for node in analysis.nodes.values():

issues/issue-150.py

@@ -17,7 +17,7 @@
 thevenin_circuit.R('load', 'load', thevenin_circuit.gnd, 1@u_kΩ)
 
 simulator = thevenin_circuit.simulator(simulator='xyce-serial', temperature=25, nominal_temperature=25)
-# simulator._spice_server._xyce_command = "C:\\progs\\Xyce 6.10 OPENSOURCE\\bin\\Xyce.exe"
+# simulator._spice_server._xyce_command = "C:\\Program Files\\Xyce 6.10 OPENSOURCE\\bin\\Xyce.exe"
 analysis = simulator.operating_point()
 
 load_node = analysis.load