Merge pull request #282 from nunobrum/adopting-clipin

Adopting clipin

Author: nunobrum

README.md

@@ -1,6 +1,6 @@
 # README <!-- omit in toc -->
 
-_current version: 1.4.8
+_current version: 1.4.9 (alpha)_
 
 *spicelib* is a toolchain of python utilities design to interact with spice simulators, as for example:
 
@@ -61,12 +61,12 @@ Try it. It's awesome. </b>
   - [Simulation Analysis Toolkit](#simulation-analysis-toolkit)
   - [ltsteps](#ltsteps)
 - [Command Line Interface](#command-line-interface)
-  - [ltsteps.exe](#ltstepsexe)
-  - [histogram.exe](#histogramexe)
-  - [raw\_convert.exe](#raw_convertexe)
-  - [rawplot.exe](#rawplotexe)
-  - [run\_server.exe](#run_serverexe)
-  - [asc\_to\_qsch.exe](#asc_to_qschexe)
+  - [ltsteps](#ltsteps)
+  - [histogram](#histogram)
+  - [raw\_convert](#raw_convert)
+  - [rawplot](#rawplot)
+  - [run\_server](#run_server)
+  - [asc\_to\_qsch](#asc_to_qsch)
 - [Other functions](#other-functions)
   - [log\\semi\_dev\_op\_reader.opLogReader](#logsemi_dev_op_readeroplogreader)
 - [Debug Logging](#debug-logging)
@@ -96,19 +96,18 @@ Try it. It's awesome. </b>
   by the user and the netlist is updated accordingly. The netlist can then be used with the SimRunner to run a batch of
   simulations or with the LTspice GUI.
 
-* __ltsteps.exe__
+* __ltsteps__
   An command line tool that extracts from LTspice output files data, and formats it for import in a spreadsheet, such like Excel
   or Calc.
 
-* __histogram.exe__
+* __histogram__
   A command line tool that uses numpy and matplotlib to create a histogram and calculate the sigma deviations. This is
   useful for Monte-Carlo analysis.
 
-* __asc_to_qsch.exe__
+* __asc_to_qsch__
   A command line tool that converts LTspice schematic format [.asc] into Qspice schematic format [.qsch]  
 
-(Note that the extension '.exe' is only available on Windows. On MacOS or Linux, the commands will have the same name,
-but without '.exe')
+(Note that in Windows operating system the command line has the extension '.exe'. )
 
 ### Main Classes
 
@@ -932,11 +931,11 @@ The second possibility is to use the module directly on the command line
 
 ## Command Line Interface
 
-The following tools will be installed when you install the library via pip. The extension '.exe' is only available on
-Windows. On MacOS or Linux, the commands will have the same name, but without '.exe'. The executables are simple links
+The following tools will be installed when you install the library via pip. In windows operating system the command
+lines receive the .exe extension. Other OSes don't have this particularity. The executables are simple links
 to python scripts with the same name, of which the majority can be found in the package's 'scripts' directory.
 
-### ltsteps.exe
+### ltsteps
 
 ```text
 Usage: ltsteps [filename]
@@ -948,7 +947,7 @@ where the data read is formatted into a more convenient tab separated format. In
 the
 script will scan the directory and process the newest log, txt or out file found.
 
-### histogram.exe
+### histogram
 
 This module uses the data inside on the filename to produce a histogram image.
 
@@ -979,7 +978,7 @@ Options:
                         Name of the image File. extension 'png'    
  ```
 
-### raw_convert.exe
+### raw_convert
 
 A tool to convert .raw files into csv or Excel files.
 
@@ -997,17 +996,21 @@ Options:
   -s SEPARATOR, --sep=SEPARATOR
                         Value separator for CSV output. Default: "\t" <TAB>
                         Example: -d ";"
+  -D DIALECT, --dialect=DIALECT
+                        Dialect to pass to RawRead (e.g., 'ltspice' ,
+                        'qspice', 'ngspice' ,'xyce')
+
 ```
 
-### rawplot.exe
+### rawplot
 
-Uses matplotlib to plot the data in the raw file.
+Uses matplotlib to plot the data in the raw file. Matplotlib must be installed for this to work.
 
 ```text
 Usage: rawplot RAW_FILE TRACE_NAME
 ```
 
-### run_server.exe
+### run_server
 
 This module is used to run a server that can be used to run simulations in a remote machine. The server will run in the
 background and will wait for a client to connect. The client will send a netlist to the server and the server will run
@@ -1073,9 +1076,9 @@ options:
                         Maximum number of parallel simulations. Default is 4
 ```
 
-### asc_to_qsch.exe
+### asc_to_qsch
 
-Converts LTspice schematics into QSPICE schematics.
+Converts LTspice schematics into QSPICE schematics. Note that not all LTspice components are supported in QSPICE.
 
 ```text
 Usage: asc_to_qsch [options] ASC_FILE [QSCH_FILE]
@@ -1127,6 +1130,11 @@ For support and improvement requests please open an Issue
 in [GitHub spicelib issues](https://github.com/nunobrum/spicelib/issues)
 
 ## History
+* Version 1.4.9
+    * Adopting clipin for clipboard operations
+    * Adding dialect support to raw_convert
+    * renamed CLI rawconvert to raw_convert for consistency
+    * Removing .exe extensions from CLI tools references in README
 * Version 1.4.8
     * Fixing Issue #269 - improved support for Ø,€,£,× components for Qspice
     * Fixing Issue #262 - Support for comments in netlists
@@ -1144,7 +1152,7 @@ in [GitHub spicelib issues](https://github.com/nunobrum/spicelib/issues)
     * Fixing Issue #235 and #236 - Inconsistent formulas in montecarlo.py and in tolerance_deviations.py
     * Fixing Issue #233 and #234 - `run_server` enhancements and platform compatibility
     * Fixing Issue #224 - Allow maintenance of `.control` sections
-    * Fixing Issue #219 - Provide an option for defining the directory in which spice is executed
+    * Fixing Issue #219 - Provides an option for defining the directory in which spice is executed
     * Fixing Issue #218 - Allow reading of multiple plots from 1 raw file
     * Fixing Issue #214 - Netlist concatenations are badly interpreted
     * Fixing Issue #213 - Add support for Verilog A elements

examples/run_montecarlo.py

@@ -20,20 +20,17 @@
 mc.set_parameter_deviation('Vos', 3e-4, 5e-3, 'uniform')  # The keyword 'distribution' is optional
 mc.prepare_testbench(num_runs=1000)  # Prepares the testbench for 1000 simulations
 
-manually_simulating_in_LTspice = False
+# Finally the netlist is saved to a file. This file contains all the instructions to run the simulation in LTspice
+mc.save_netlist('./testfiles/temp/sallenkey_mc.asc')
+# -- End of Example 1 --
 
-if manually_simulating_in_LTspice:
-    # Finally the netlist is saved to a file. This file contains all the instructions to run the simulation in LTspice
-    mc.save_netlist('./testfiles/temp/sallenkey_mc.asc')
-    # -- End of Example 1 --
-else:
-    # Using the Toolkit to run the simulation.
-    mc.run_testbench(runs_per_sim=100, exe_log=False)  # Runs the simulation with splits of 100 runs each
-    logs = mc.read_logfiles()   # Reads the log files and stores the results in the results attribute
-    logs.obtain_amplitude_and_phase_from_complex_values()  # Splits the complex values into real and imaginary parts
-    logs.export_data('./temp_mc/data_testbench.csv')  # Exports the data to a csv file
-    logs.plot_histogram('fcut')  # Plots the histograms for the results
-    mc.cleanup_files()  # Deletes the temporary files
+# Using the Toolkit to run the simulation.
+mc.run_testbench(runs_per_sim=100, exe_log=False)  # Runs the simulation with splits of 100 runs each
+logs = mc.read_logfiles()   # Reads the log files and stores the results in the results attribute
+logs.obtain_amplitude_and_phase_from_complex_values()  # Splits the complex values into real and imaginary parts
+logs.export_data('./temp_mc/data_testbench.csv')  # Exports the data to a csv file
+logs.plot_histogram('fcut')  # Plots the histograms for the results
+mc.cleanup_files()  # Deletes the temporary files
 
 print("=====================================")
 a = input("Make 1000 simulations ? [Y/N]")

pyproject.toml

@@ -17,14 +17,15 @@ numpy = "*"
 scipy = "*"
 psutil = "*"
 matplotlib = "*"
+clipin = "*"
 
 [tool.poetry.scripts]
 ltsteps = "spicelib.scripts.ltsteps:main"
 histogram = "spicelib.scripts.histogram:main"
 rawplot = "spicelib.scripts.rawplot:main"
 run_server = "spicelib.scripts.run_server:main"
 asc_to_qsch = "spicelib.scripts.asc_to_qsch:main"
-rawconvert = "spicelib.raw.raw_convert:main"
+raw_convert = "spicelib.scripts.raw_convert:main"
 readme_update = "spicelib.scripts.readme_update:main"
 
 [tool.poetry.urls]

spicelib/__init__.py

@@ -7,7 +7,6 @@
 from .editor.asc_editor import AscEditor
 from .editor.qsch_editor import QschEditor
 from .sim.sim_runner import SimRunner
-from .utils.clipboard import Clipboard
 
 
 def all_loggers():

spicelib/log/logfile_data.py

@@ -96,9 +96,13 @@ def try_convert_value(value: Union[str, int, float, list]) -> Union[int, float,
             ans = float(value)
         except ValueError:
             try:
-                ans = LTComplex(value)
+                # Tries to convert to complex
+                ans = complex(value)
             except ValueError:
-                ans = value.strip()  # Removes the leading trailing spaces
+                try:
+                    ans = LTComplex(value)
+                except ValueError:
+                    ans = value.strip()  # Removes the leading trailing spaces
     return ans
 
 

spicelib/scripts/histogram.py

@@ -73,7 +73,7 @@ def main():
     from optparse import OptionParser
 
     usage = "usage: %prog [options] LOG_FILE TRACE"
-    opts = OptionParser(usage=usage, version="%prog 0.1")
+    opts = OptionParser(usage=usage, version="%prog 1.2")
     # opts.add_option('v', "var", action="store", type="string", dest="trace", help="The trace to be used in the histogram")
     opts.add_option('-s', "--sigma", action="store", type="int", dest="sigma", default=3,
                     help="Sigma to be used in the distribution fit. Default=3")
@@ -94,7 +94,8 @@ def main():
     opts.add_option('-r', "--range", action="store", type="string", dest="range",
                     help="Range of the X axis to use for the histogram in the form min:max. Example: -r -1:1")
     opts.add_option('-C', "--clipboard", action="store_true", dest="clipboard",
-                    help="If the data from the clipboard is to be used.")
+                    help="If the data from the clipboard is to be used. If a full CSV is in the clipboard the user must provide the TRACE name as well."
+                         " If no TRACE is provided the script will try to convert all lines in the clipboard to numeric values.")
     # opts.add_option('-x', "--xname", action="store", dest="xname", help="Name for the variable displayed")
     opts.add_option('-o', "--output", action="store", type="string", dest="imagefile",
                     help="Output the image to a file. Argument is the name of the image File with png extension.\n"
@@ -108,24 +109,56 @@ def main():
 
     if options.clipboard:
 
-        from spicelib.utils.clipboard import Clipboard
+        import clipin
+
 
-        cb = Clipboard()
-        
         if len(args) > 0:
             TRACE = args[-1]
         else:
             TRACE = "var"
 
-        text = cb.paste()
+        text = clipin.paste('text/plain')
 
-        del(cb)
+        if len(args) == 0:
+            for line in text.split('\n'):
+                try:
+                    values.append(try_convert_value(line))
+                except ValueError:
+                    print("Failed to convert line: '", line, "'")
+
+            if len(values) == 0:
+                print("No valid numeric values found in clipboard.")
+                exit(-1)
+
+        elif len(args) == 1:  # The user provided the trace name
+            header = text.split('\n')[0]
+            for sep in ['\t', ';', ',']:
+                if sep in header:
+                    break
+            else:
+                sep = None
 
-        for line in text.split('\n'):
+            vars = header.split(sep)
             try:
-                values.append(try_convert_value(line))
+                sav_col = vars.index(TRACE)
             except ValueError:
-                print("Failed to convert line: '", line, "'")
+                print("Clipboard data doesn't have trace '%s'" % TRACE)
+                print("Clipboard data contains %s" % vars)
+                exit(-1)
+
+            for line in text.split('\n')[1:]:
+                if line.strip() == '':
+                    continue
+                vs = line.split(sep)
+                try:
+                    values.append(try_convert_value(vs[sav_col]))
+                except ValueError:
+                    print("Failed to convert value: '", vs[sav_col], "'")
+                    continue
+                except IndexError:
+                    print("Line has not enough columns: '", line, "'")
+                    continue
+
     elif len(args) == 0:
         opts.print_help()
         exit(-1)
@@ -211,7 +244,12 @@ def main():
         print("Not enough elements for an histogram."
               f"Only found {len(values)} elements. Histogram is specified for {options.nbins} bins")
     else:
-        x = np.array(values, dtype=float)
+        value_type = type(values[0])
+        print("Data type detected: ", value_type)
+        if value_type in [int, float]:
+            x = np.array(values, dtype=float)
+        elif value_type == complex:
+            x = abs(np.array([v.real for v in values], dtype=complex)) # Can be changed to .real or .imag
         mu = x.mean()
         mn = x.min()
         mx = x.max()

spicelib/raw/raw_convert.py spicelib/scripts/raw_convert.pyspicelib/raw/raw_convert.py renamed to spicelib/scripts/raw_convert.py

@@ -46,7 +46,7 @@
 
 def main():
     usage = "usage: %prog [options] <rawfile> <trace_list>"
-    parser = OptionParser(usage=usage, version="%prog 0.1")
+    parser = OptionParser(usage=usage, version="%prog 1.2")
     parser.add_option("-o", "--output", dest="output", default=None,
                       help="Output file name.\n"
                            "Use .csv for CSV output, .xlsx for Excel output",
@@ -59,6 +59,9 @@ def main():
                       help='Value separator for CSV output. Default: "\\t" <TAB>\n'
                            'Example: -d ";"'
                       )
+    parser.add_option('-D', '--dialect', dest='dialect', default=None,
+                      help="Dialect to pass to RawRead (e.g., 'ltspice' , 'qspice', 'ngspice' ,'xyce')")
+
 
     (options, args) = parser.parse_args()
 
@@ -76,7 +79,7 @@ def main():
 
     # Read the raw file
     if traces != '*':
-        raw_data = RawRead(rawfile, '*', header_only=True, verbose=False)
+        raw_data = RawRead(rawfile, verbose=False, dialect=options.dialect)
         raw_traces = raw_data.get_trace_names()
         found_traces = []
         for trace in traces:
@@ -95,16 +98,17 @@ def main():
                     else:
                         print("Warning: Trace " + trace + " not found")
 
+
         if len(found_traces) == 0:
             print("Error: No traces found")
             print("Available Traces:\n ")
             for trace in raw_traces:
                 print("\t<" + trace + ">")
             exit(1)
         print("Reading traces: ", found_traces)
-        raw_data = RawRead(rawfile, found_traces, verbose=options.verbose)
+
     else:
-        raw_data = RawRead(rawfile, traces, verbose=options.verbose)
+        raw_data = RawRead(rawfile, traces, dialect=options.dialect, verbose=options.verbose)
 
     # Output the file
     if options.output is None:
@@ -115,11 +119,9 @@ def main():
         for i in range(data_size):
             text += options.separator.join([str(data[col][i]) for col in data.keys()]) + '\n'
         if options.clipboard:
-            from spicelib.utils.clipboard import Clipboard
-            cb = Clipboard()
+            import clipin
             print(f"Copying to clipboard text with {len(text)} bytes")
-            cb.copy(text)
-            del(cb)
+            clipin.copy({'text/plain': text})
         else:
             print(text)
     else: