barsukov 0.0.5__py3-none-any.whl → 1.0.9__py3-none-any.whl

barsukov/script.py

@@ -1,82 +1,153 @@
-from barsukov.time import *
-from barsukov.logger import Logger
-
-import sys
-import os
-
-class Script():
-    def __init__(self,
-        ### Please ALWAYS specify the following:
-        operator='Anon', # ib, Rundong, Sasha, Ameerah, Alex, or AlexH if ambiguous  
-        station='No Stn', # qd, ppms, mseppms, data, orange, ...
-        sample='No Sample', # Use sample name from the sample table, e.g. "cro2410a1" or "yig2207"
-        description='No Description', # Briefly: what are you doing. Sets the folder name.
-        # i.e. 'Testing modulation' or 'fH OOP long average'
-        project_folder = os.getcwd(), # Full path to your project folder. Please follow this convention:
-        # D:/Rundong/Projects/AFM sims/2024-07-06 Autooscillations
-        # Will grab the current directory if not specified.
-
-        ### Optional:
-        log='both', # This is the default log setting which will be passed to the logger.
-            ### It will be overriden by other objects,
-            ### which in turn will be overriden by methods.
-            ### Choose here and everywhere from screen, file, both, no.
-
-        ### Usually, it's better not to change these:
-        log_full_folder_path=None,
-        log_full_file_path=None 
-        ):
-        
-        self.operator = operator
-        self.station = station
-        self.sample = sample
-        self.description = description
-        self.project_folder = project_folder
-
-        self.rm = None
-        
-        ### Creating the sub-project folder
-        self.folder_name = date() + '_' + self.station + '_' + self.operator + '_' + self.sample + '_' + self.description
-        self.full_folder_path = os.path.join(self.project_folder, self.folder_name)
-        os.makedirs(self.full_folder_path, exist_ok=True)
-
-        ### Starting the logger
-        if log_full_folder_path is None:
-            self.logger = Logger(
-                description=self.operator + '_' + self.description,
-                full_file_path=log_full_file_path,
-                log=log, # Script.log becomes Logger's default
-                start_file=True)
-        else:
-            self.logger = Logger(
-                description=self.operator + '_' + self.description,
-                full_folder_path=log_full_folder_path,
-                full_file_path=log_full_file_path,
-                log=log, # Script.log becomes Logger's default
-                start_file=True) 
-        
-        self.logger.log(f'Script object initialized. Logger started.', log='both')
-        
-    def log(self, msg, log='default'): # default means the default of the logger
-        self.logger.log(msg, log=log)
-    
-
-### BEGIN: Equipment related stuff
-
-    def init_rm(self):
-    # Imports pyvisa as method library #
-        import pyvisa as visa # ----------------XXX Can this be done like this??????????????
-        try: 
-            self.rm = visa.ResourceManager()
-        except:
-            self.rm = None
-            self.log('Script could not import pyvisa.', log='important')
-            sys.exit()
-        self.log(f'Script started pyvisa.ResourceManager.', log='both')
-        return self.rm
-
-### BEGIN Equipment devices
-    
-    def mwHP(self, **kwargs):
-        from barsukov.exp.mwHP import mwHP as eq
-        return eq(**kwargs, script=self, logger=self.logger)
+### BEGIN Dependencies ###
+import sys
+import os
+from barsukov.time import *
+from barsukov.logger import Logger
+### END Dependencies
+
+
+class Script():
+    """
+    A class that represents a scientific experiment script, managing logging, file handing, and device initialization.
+
+    Args:
+        RECOMMENDED:
+        operator (str): The name of the operator (default: 'Anon').
+        station (str): The station of the experiment (default: 'No-Station').
+        sample (str): The sample being tested (default: 'No-Sample').
+        description (str): A brief description of the experiment (default: 'No-Description').
+        project_folder (str): The base folder for the project files (default: current directory).
+
+        OPTIONAL:
+        log (str, optional): The logging configuration (default: 'both')
+            This is the default log setting which will be passed to the logger.
+            It will be overriden by other objects, which in turn will be overriden by methods.
+            Choose here and everywhere from 'screen', 'file', 'both', 'no'.
+
+        BEST NOT TO CHANGE:
+        log_full_folder_path (str, optional): Path to save logs (default: current directory).
+        log_full_file_path (str, optional): Full path for log file (default: None).
+
+    Attributes:
+        operator (str): The operator's name (e.g., 'ib', 'Rundong', 'Sasha', 'Ameerah', 'Steven', 'Alex', or 'AlexH' if ambiguous).
+        station (str): The station where the experiment is conducted (e.g., 'qd', 'ppms', 'mseppms', 'data', 'orange', ...).
+        sample (str): The sample being used in the experiment (e.g. 'cro2410a1').
+        description (str): A brief description of the experiment (e.g., 'Testing modulation').
+        project_folder (str): Absolute path to the directory (e.g., 'D:/Rundong/Projects/AFM sims/2024-07-06 Autooscillations').
+        folder_name (str): A generated folder name based on the experiment details.
+        full_folder_path (str): The full path to the experiment folder.
+        logger (Logger): A Logger instance for logging experiment data.
+        rm (ResourceManager or None): The pyvisa ResourceManager used for controlling instruments.
+    """
+### BEGIN: Initializing tools
+    def __init__(self, 
+        operator='Anon',
+        station='No-Station',
+        sample='No-Sample',
+        description='No-Description',
+        project_folder = os.getcwd(),
+        log='both', 
+        log_full_folder_path=os.getcwd(),
+        log_full_file_path=None, 
+        ):
+
+        ### Description Attributes
+        self.operator = operator
+        self.station = station
+        self.sample = sample
+        self.description = description
+        self.project_folder = project_folder
+
+        ### Creating the sub-project folder
+        self.folder_name = f"{date()}_{self.station}_{self.operator}_{self.sample}_{self.description}"
+        self.full_folder_path = os.path.join(self.project_folder, self.folder_name)
+        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.logger_name = self.logger.full_file_path
+
+        ### Equipment Attributes
+        self.rm = None
+        self.equipment = None
+
+    def init_logger(self, start):
+        ### Starting the logger
+        self.logger = Logger(
+            description=f"{self.operator}_{self.description}",
+            full_folder_path=self.log_full_folder_path,
+            full_file_path=self.log_full_file_path,
+            log=self.log_mode, # Script.log becomes Logger's default
+            start_file=start)
+        self.logger.log(f'Script object initialized. Logger started.', log='both')
+
+
+    def log(self, msg, log='default'):
+        """
+        Logs a message using the Script object's logger.
+
+        Args:
+            msg (str): The message to log.
+            log (str, optional): The log destination (e.g., 'screen', 'file', 'both'). Defaults to the 'default' of the logger
+        """
+        self.logger.log(msg, log=log)
+### END: Initializing tools
+
+
+### BEGIN: Equipment related stuff
+    def init_rm(self):
+        # Initializes the pyvisa ResourceManager for controlling instruments.
+        # Returns ResourceManager The pyvisa ResourceManager object.
+        # Raises SystemExit If pyvisa cannot be imported or the ResourceManager cannot be initialized.
+        self.equipment = True
+        import pyvisa as visa
+        try: 
+            self.rm = visa.ResourceManager()
+        except:
+            self.rm = None
+            self.log('Script could not import pyvisa.', log='important')
+            sys.exit()
+        self.log(f'Script started pyvisa.ResourceManager.', log='both')
+        return self.rm
+### END: Equipment related stuff
+
+
+### BEGIN: Equipment devices
+    def mwHP(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.mwHP import mwHP as eq
+        return eq(gpib, logger=self.logger, script=self, **kwargs)
+### END: Equipment devices
+
+
+### BEGIN: OBJ2FILE TOOLS:
+    def __getstate__(self):
+        # 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
+
+
+    def __setstate__(self, seriable_data):
+        # 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)
+        if self.equipment is True: self.init_rm()
+### END: OBJ2FILE TOOLS:

barsukov/time.py

@@ -1,16 +1,37 @@
-### BEGIN Dependencies ###
-import datetime
-from pytz import timezone
-### END Dependencies ###
-
-TIMEZONE = timezone('America/Los_Angeles')
-
-def time_stamp(): # YYYY-MM-DD_HH-MM-SSS, last digit is 1/10th of the second
-    now = datetime.datetime.now(TIMEZONE)
-    formatted_datetime = now.strftime(f"%Y-%m-%d_%H-%M-%S") + str(int( now.microsecond / 100000 ))
-    return formatted_datetime
-
-def date(): # YYYY-MM-DD
-    now = datetime.datetime.now(TIMEZONE)
-    formatted_datetime = now.strftime(f"%Y-%m-%d")
-    return formatted_datetime
+### BEGIN Dependencies ###
+import datetime
+from pytz import timezone
+### END Dependencies ###
+
+TIMEZONE = timezone('America/Los_Angeles')
+
+def time_stamp():
+    """
+    Generates a timestamp in the format 'YYYY-MM-DD_HH-MM-SSS', where the last digit represents 1/10th of a second based on the current date and time.
+
+    returns:
+        str: A string representing the current date and time in the format 'YYYY-MM-DD_HH-MM-SSS'.
+
+    Example:
+        >>> time_stamp()
+        '2025-01-28_17-27-210'
+    """
+    now = datetime.datetime.now(TIMEZONE)
+    formatted_datetime = now.strftime(f"%Y-%m-%d_%H-%M-%S") + str(int( now.microsecond / 100000 ))
+    return formatted_datetime
+
+
+def date(): 
+    """
+    Generates the current date in the format 'YYYY-MM-DD'.
+
+    Returns:
+        str: A string representing the current date in the format 'YYYY-MM-DD'.
+
+    Example:
+        >>> date()
+        '2025-01-28'
+    """
+    now = datetime.datetime.now(TIMEZONE)
+    formatted_datetime = now.strftime(f"%Y-%m-%d")
+    return formatted_datetime

{barsukov-0.0.5.dist-info → barsukov-1.0.9.dist-info}/METADATA

@@ -1,48 +1,47 @@
-Metadata-Version: 2.2
-Name: barsukov
-Version: 0.0.5
-Summary: Experiment Automation Package
-Author-email: Igor Barsukov <igorb@ucr.edu>
-Maintainer-email: Steven Castaneda <scast206@ucr.edu>
-Project-URL: Homepage, https://barsukov.ucr.edu
-Classifier: Programming Language :: Python :: 3
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-Requires-Dist: pytz>=2014.10
-Requires-Dist: numpy>=1.20.0
-Requires-Dist: scipy>=1.15.1
-
-# Barsukov
-
-Barsukov is a Python library for experiment automation.
-
-## Installation
-
-Use the package manager [pip](https://pip.pypa.io/en/stable/) to install barsukov.
-
-```bash
-pip install barsukov
-```
-
-## Usage
-
-```python
-#
-#
-#
-#
-#
-#
-#
-```
-
-## Contributing
-
--
--
--
-
-## License
-
-[MIT](https://choosealicense.com/licenses/mit/)
+Metadata-Version: 2.2
+Name: barsukov
+Version: 1.0.9
+Summary: Experiment Automation Package
+Author-email: Igor Barsukov <igorb@ucr.edu>, Steven Castaneda <scast206@ucr.edu>
+Project-URL: Homepage, https://barsukov.ucr.edu
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+Requires-Dist: pytz>=2014.10
+Requires-Dist: numpy>=1.0.0
+Requires-Dist: scipy>=0.9.0
+
+# Barsukov
+
+Barsukov is a Python library for experiment automation.
+
+## Installation
+
+Use the package manager [pip](https://pip.pypa.io/en/stable/) to install barsukov.
+
+```bash
+pip install barsukov
+```
+
+## Usage
+
+```python
+#
+#
+#
+#
+#
+#
+#
+```
+
+## Contributing
+
+-
+-
+-
+
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)

barsukov-1.0.9.dist-info/RECORD

@@ -0,0 +1,14 @@
+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.0.9.dist-info/METADATA,sha256=OUhd6M4Wnqi7sWE7jyokT01gh7-djeGW6jeh40alpHM,791
+barsukov-1.0.9.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+barsukov-1.0.9.dist-info/top_level.txt,sha256=Js5sHbNjP0UNMB9O5HtCHZqlfHabuNS8nTsHbg-1DDQ,9
+barsukov-1.0.9.dist-info/RECORD,,

barsukov-0.0.5.dist-info/RECORD

@@ -1,14 +0,0 @@
-barsukov/__init__.py,sha256=5m-RSzmBVqzfuBuo2Eqj-DCiKgOfKhqvGr9E5mPTdl4,257
-barsukov/logger.py,sha256=kWSiJJSjI4EtCxW5fyAww-6BQAFnCk-Gv8OIdtXH5pg,5275
-barsukov/obj2file.py,sha256=kNEDM7wcAUbeg7qbztZrKsxcOQEi2JmB-qQzaOO50Cc,3879
-barsukov/script.py,sha256=CaO3g3uW08Lt2h_4Gxcx7gTWRVg2FZoWSlEzD7YhHH0,3379
-barsukov/time.py,sha256=6YVvay-ISO5VpyHG8WGUelGfaN1N18ktRrP37MVbdyU,552
-barsukov/data/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-barsukov/data/fft.py,sha256=VwY1h0ZB8xy_mxoI8zPESRLM7nk5NbiGi3wC6vg6T-k,4452
-barsukov/exp/__init__.py,sha256=urLfGpap40kN9ULi53JB0NT-iMsZDSFdBmdSq3ckB0E,19
-barsukov/exp/exp_utils.py,sha256=jpmSt-4XGwK4QWR8SEi1s0JPwUavO8Smmc4y6bO0giU,4091
-barsukov/exp/mwHP.py,sha256=auZmIgxtbZyzS_x0jk5uhNHioAuJKnAUHeB-fJoSF3w,19023
-barsukov-0.0.5.dist-info/METADATA,sha256=FTDVG2ZLzSrh8bHj34Fi93MibQYLXoq9z3J2X3MVwh0,858
-barsukov-0.0.5.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-barsukov-0.0.5.dist-info/top_level.txt,sha256=Js5sHbNjP0UNMB9O5HtCHZqlfHabuNS8nTsHbg-1DDQ,9
-barsukov-0.0.5.dist-info/RECORD,,