barsukov 1.3.3__py3-none-any.whl → 1.3.5__py3-none-any.whl

barsukov/exp/smKE.py

@@ -0,0 +1,148 @@
+### BEGIN Dependencies ###
+import numpy as np
+import sys
+from barsukov.exp.exp_utils import *
+### END Dependencies
+
+
+class smKE:
+    def __init__(self, gpib=None, visa_rm=None, logger=None, gpib_card=0, log='default', script=None):
+        # Pass the Script object, if available.
+        # If Script has no visa_rm or if no Script is passed, you'll need to pass the visa_rm=visa.ResourceManager manually.
+        # If Script has no logger or if no Script is passed, you can pass the logger manually.
+        # If no logger is passed, will simply print to screen.
+        # Change log from 'default' to 'screen', 'file', 'both', 'no'.
+        # gpib_card is per default 0. You can change, if you have multiple.
+
+        self.script = script
+        self.logger = logger
+        self.eq_default_log = log
+        self.rm = visa_rm
+        self.gpib_card = gpib_card
+        self.gpib = gpib
+
+        self.msg_deco = f'[smKE {self.gpib_card}::{self.gpib}]'
+        self.eq = initialize_gpib(self) # This will initialize self.eq = visa.open_resource()
+        self.log( f'Initialized: {self.identify()}', log='important' ) # This is the 'welcome message' and a check if communication works.
+        
+        # Digits, x_Min, x_Max, Range_min, Range_max, units, function
+        self.I_params = [10, -1.05, 1.05, 1e-6, 1, 'A', 'curr']
+        self.V_params = [10, -210.0, 210.0, 0, 210.0, 'V', 'volt'] #digits and range undetermined
+        self.R_params = [10, 0.0, 2.1e8, 'R'] #digits undetermined
+
+### BEGIN The definition of the following functions may be specific to this equipment.
+    def query(self, cmd):
+        return self.eq.query(cmd)
+
+    def write(self, cmd):
+        return self.eq.write(cmd)
+
+    def identify(self):
+        return str(self.eq.query('*IDN?'))
+### END The definition of the following functions may be specific to this equipment.
+    def disconnect(self):
+        eq_disconnect(self)
+
+    def reconnect(self):
+        eq_reconnect(self)
+
+    def log(self, msg, log=None):
+        if log is None: log=self.eq_default_log
+        log_in_eq(self, msg, log=log)
+### END These functions could be shared across all equipment.\
+
+    def source(self, function=None, scale=None, level=None, cmpl_scale=None, cmpl_level=None, log=None):
+        if log is None: log=self.eq_default_log
+        if function is None:
+            try:
+                f = self.eq.query('sour:func?')
+                f = str(f)[:-1]
+
+                s = self.eq.query(f'sour:{f}:rang?')
+                s = float(s) / 1.05
+                exp = np.floor(np.log10(abs(s)))
+                s = np.ceil(s / 10**exp) * 10**exp
+
+                l = self.eq.query(f'sour:{f}:lev?')
+                l = float(l)
+
+                if f == 'CURR': source_param, compliance_param = self.I_params, self.V_params
+                if f == 'VOLT': source_param, compliance_param = self.V_params, self.I_params
+
+                cs = self.eq.query(f'sens:{source_param[6]}:rang?')
+                cs = float(cs)
+
+                cl = self.eq.query(f'sens:{source_param[6]}:prot?')
+                cl = float(cl)
+
+                self.log(f'Source function is {f}, scale is {s} {source_param[5]}, level is {l} {source_param[5]}. Compliance scale is {cs} {compliance_param[5]}, level is {cl} {compliance_param[5]}')
+                return f, s, l, cs, cl
+
+            except:
+                self.log(f'Error while reading source function.', log='important')
+                return np.nan
+        else:
+            if (function == 'curr') or (function == 'current'): source_param, compliance_param = self.I_params, self.V_params
+            else: source_param, compliance_param,  = self.V_params, self.I_params
+            try:
+                if level > scale: level = scale #level must be equal to or less than scale
+                if cmpl_level > cmpl_scale: cmpl_level = cmpl_scale
+
+                f = source_param[6]
+                self.eq.write(f'sour:func {f}')
+                self.eq.write(f'sour:{f}:mode fix')
+
+                s = max(source_param[3], min(float(scale), source_param[4]))
+                self.eq.write(f'sour:{f}:rang {s}')
+
+                l = max(source_param[1], min(float(level), source_param[2]))
+                self.eq.write(f'sour:{f}:lev {l}')
+
+                cs = max(compliance_param[3], min(float(cmpl_scale), compliace_param[4]))
+                self.eq.write(f'sens:{compliance_param[6]}rang:auto off')
+                self.eq.write(f'sens:{compliance_param[6]}:rang: {cs}')
+
+                cl = max(compliance_param[1], min(float(cmpl_level), compliance_param[2]))
+                self.eq.write(f'sens:{compliance_param[6]}:prot:rsyn on')
+                self.eq.write(f'sens:{compliance_param[6]}:prot {cmpl_level}')
+
+                freal, sreal, lreal, csreal, clreal = self.source()
+                return freal, sreal, lreal, csreal, clreal
+
+            except:
+                self.log(f'Error while changing Source.', log='important')
+                return np.nan
+
+    def measure(self, function=None, four_wire=None, res_mode=None, res_guard=None, res_compensation=None, log=None):
+        if log is None: log=self.eq_default_log
+        if function is None:
+            try:
+                f = self.eq.query('sens:func?')
+                f = str(f)[:-1]
+
+                ws = self.eq.query('syst:rsen?')
+                ws = float(ws)
+                if ws: ws = 'on'
+                else: ws = 'off'
+
+                #self.log(f'Measure function
+
+                if 'RES' in f:
+                    rm = self.eq.query('res:mode?')
+                    rm = str(f)[:-1]
+
+                    rg = self.eq.query('syst:guard?')
+                    rg = str(f)[:-1]
+
+                    rc = self.eq.query('res:ocom?')
+                    if ws: ws = 'on'
+                    else: ws = 'off'
+
+            except:
+                return 0
+
+        self.eq.write(f'sens:func:off:all')
+        self.eq.write(f'sens:func:on "{function}"')
+        self.eq.write(f'{function}:mode {source}')
+        self.eq.write(f'syst:rsen {sense_mode}')
+        self.eq.write(f'syst:guard {guard}')

barsukov/logger.py

@@ -73,7 +73,7 @@ class Logger:
             full_folder_path = self.full_folder_path
 
         ### Create a file name like log_timeStamp_description_.txt ###
-        if not (description is None or description == ''):
+        if description is not None and description != '':
             description = f"_{description}"
         else:
             description = ''
@@ -104,10 +104,11 @@ class Logger:
 
     def write_to_file(self, msg):
         if self.file:
+            #add lock here
             self.file.write(msg)
             ### flushing the log file to make sure it's written ###
             self.file.flush()
-            os.fsync(self.file)
+            #os.fsync(self.file) ##.fileno()
         else:
             self.file_error = True
             print(f'{time_stamp()} Logger is trying to write to a closed or non-existent file.')
@@ -119,7 +120,7 @@ class Logger:
             log = 'screen'
         elif log == 'important' and self.log_mode == 'file':
             log = 'both'
-        elif (log == 'important') or(log == 'default') or (log is None):
+        elif (log == 'important') or (log == 'default') or (log is None):
             log = self.log_mode
 
         decorated_message = self.decorated_msg(msg)

barsukov/script.py

@@ -64,11 +64,10 @@ class Script():
         os.makedirs(self.full_folder_path, exist_ok=True)
 
         ### Logger Attributes
-        self.start_logger = True
         self.log_mode = log
         self.log_full_folder_path = log_full_folder_path
         self.log_full_file_path = log_full_file_path
-        self.init_logger(start=self.start_logger)
+        self.init_logger(start=True)
         self.logger_name = self.logger.full_file_path
 
         ### Equipment Attributes
@@ -130,6 +129,20 @@ class Script():
         """
         from barsukov.exp.mwHP import mwHP as eq
         return eq(gpib, logger=self.logger, script=self, **kwargs)
+
+    def smKE(self, gpib=None, **kwargs):
+        """
+        Initializes and returns a mwHP equipment object with the specified parameters.
+
+        Args:
+            gpib (str): gpib number of equipment. Defaults to 'None'.
+            **kwargs: Additional keyword arguments passed to the mwHP equipment initialization.
+
+        Returns:
+            mwHP: A mwHP equipment object.
+        """
+        from barsukov.exp.smKE import smKE as eq
+        return eq(gpib, logger=self.logger, script=self, **kwargs)
 ### END: Equipment devices
 
 
@@ -138,7 +151,6 @@ class Script():
         # Prepares the Script object for serialization by removing non-seriable attributes (e.g. logger and rm).
         # Returns a dict: A dictionary representing the serializable state of the Script object.
         seriable_data = self.__dict__.copy()
-        seriable_data['start_log'] = False
         del seriable_data['logger']
         del seriable_data['rm']
         return seriable_data
@@ -148,6 +160,6 @@ class Script():
         # Restores the Script object from its serialized state, including reinitializing the logger and rm.
         # Args: seriable_data (dict): A dictionary representing the serialized state of the Script object
         self.__dict__.update(seriable_data)
-        self.init_logger(self.start_logger)
+        self.init_logger(start=False)
         if self.equipment is True: self.init_rm()
 ### END: OBJ2FILE TOOLS:

barsukov/time.py

@@ -21,7 +21,7 @@ def time_stamp():
     return formatted_datetime
 
 
-def date(): 
+def date():
     """
     Generates the current date in the format 'YYYY-MM-DD'.
 

{barsukov-1.3.3.dist-info → barsukov-1.3.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: barsukov
-Version: 1.3.3
+Version: 1.3.5
 Summary: Experiment Automation Package
 Author-email: Igor Barsukov <igorb@ucr.edu>, Steven Castaneda <scast206@ucr.edu>
 Project-URL: Homepage, https://barsukov.ucr.edu
@@ -16,6 +16,10 @@ Requires-Dist: scipy>=0.9.0
 
 Barsukov is a Python library for experiment automation.
 
+## For Developers
+
+To push to PyPi, commit to main on Github Desktop, click the history tab, right click and create tag, format the tag v\*.\*.\* and push to the repository (ctrl+p).
+
 ## Installation
 
 Use the package manager [pip](https://pip.pypa.io/en/stable/) to install barsukov.

barsukov-1.3.5.dist-info/RECORD

@@ -0,0 +1,20 @@
+barsukov/__init__.py,sha256=7frhJ1d67SdEKCZKmi4Zr-2QnQzFA-YK2Pki4IQYKEw,202
+barsukov/logger.py,sha256=BBqeid3kX7RJLKmHS4E1jH3KmlIrU3vaR4udSkk4gd4,6529
+barsukov/obj2file.py,sha256=nivCmCEpmOSaG4VpQgIDb-7hsvdEq45Iuu5HOfRxbcw,3923
+barsukov/script.py,sha256=JdTL-w-4FLh5k6T1IHnxX3zT4CQzDUfAs6usHHMUE30,6775
+barsukov/time.py,sha256=apjdgwCXDNBAMyVfsAvfcORz4BkU2--d1BDLHIl_ar4,1038
+barsukov/data/Change_phase.py,sha256=jOCjO4vvk39PEWhOTnLwaPZd769gCDz71nfKwIgSz6I,6998
+barsukov/data/Lock_in_emulator.py,sha256=XbzB-RQUVP5qiCyoAN_r1jG98ZRXN9YGxxvlM0m2XbY,7099
+barsukov/data/__init__.py,sha256=f6krjlrpD4BhytHkKp5UttzPR1ZGmoNZODxBX6Wcay0,183
+barsukov/data/constants.py,sha256=SsnqLCjD1M_To7vpr2yXLE4djw4Yc7302t8cKhPWLgQ,156
+barsukov/data/fft.py,sha256=C-PRVySyMYmSJva_S8OwjJBB26pp45ttndjgcaYXZkE,5655
+barsukov/data/lock_in_emulator_app.py,sha256=-oZEBClSHol0iXpOgL0NRaKvy5DpyGthaPmkU9oPkc4,11586
+barsukov/data/noise.py,sha256=MsLifk1Uyq6mjMcYq8ovuskOTRwsrZNqYRRs37IONOc,10504
+barsukov/exp/__init__.py,sha256=DBzvcR0flW6ouWFdmOxngPzyFx_6t5ECztspJ8uX89M,39
+barsukov/exp/exp_utils.py,sha256=7qVQJbJGbsNW0JZQ7A1cmI73J6vi_aN8Zu6WMq2-7LE,4789
+barsukov/exp/mwHP.py,sha256=KAaQPeNI67_xxx-6JesfViHRkWPUqkufdrkwoVZzBnY,12591
+barsukov/exp/smKE.py,sha256=EAhl1WjNv5dP_eZDPfQ-4qdtH8KOvLhNLM666VIvLuM,6107
+barsukov-1.3.5.dist-info/METADATA,sha256=6CAGLrrJQaFi4B6-EP7zXeIrfjGr6B474sVTI73on30,975
+barsukov-1.3.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+barsukov-1.3.5.dist-info/top_level.txt,sha256=Js5sHbNjP0UNMB9O5HtCHZqlfHabuNS8nTsHbg-1DDQ,9
+barsukov-1.3.5.dist-info/RECORD,,

{barsukov-1.3.3.dist-info → barsukov-1.3.5.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.8.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

barsukov-1.3.3.dist-info/RECORD

@@ -1,14 +0,0 @@
-barsukov/__init__.py,sha256=GVsEnM_uD4x1XN_PIKdD-VSRMNUnvPr2iCWuEHwM6sU,293
-barsukov/logger.py,sha256=nrkS1Pg3WGEjRJQ5MbplhyGYGbfFGkgyxgx1qdSu1x0,6489
-barsukov/obj2file.py,sha256=nivCmCEpmOSaG4VpQgIDb-7hsvdEq45Iuu5HOfRxbcw,3923
-barsukov/script.py,sha256=nrKwEl60u9ces3B8FwRfY4VmlEx5bNvk_hoPaylldP0,6359
-barsukov/time.py,sha256=fSf5JKqr6Pd5691qQcFuBsjDd9alMrfASnndlstLits,1039
-barsukov/data/__init__.py,sha256=IMnOEliXsRMPWeCTprPSddRKg9kwfV-neQiwUwHdpqs,19
-barsukov/data/fft.py,sha256=f9aPLeusVpWiWmXO5n4XwkfQ9xJQhZVFdyhFoT9DB2A,4365
-barsukov/exp/__init__.py,sha256=urLfGpap40kN9ULi53JB0NT-iMsZDSFdBmdSq3ckB0E,19
-barsukov/exp/exp_utils.py,sha256=7qVQJbJGbsNW0JZQ7A1cmI73J6vi_aN8Zu6WMq2-7LE,4789
-barsukov/exp/mwHP.py,sha256=eoX82jon5nIsExvRHO1PIOQAWWWhJYY4N21VtoLXuSw,12136
-barsukov-1.3.3.dist-info/METADATA,sha256=W5yH8yp2NKZgWqTi2TLUFW3xYSo7lzfy7IS7bNj7Y4k,791
-barsukov-1.3.3.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-barsukov-1.3.3.dist-info/top_level.txt,sha256=Js5sHbNjP0UNMB9O5HtCHZqlfHabuNS8nTsHbg-1DDQ,9
-barsukov-1.3.3.dist-info/RECORD,,