qkit 0.5.0__tar.gz → 0.5.2__tar.gz

qkit-0.5.2/CITATION.cff

@@ -0,0 +1,14 @@
+cff-version: 1.2.0
+authors:
+  - name: "qkitgroup"
+  - name: "KIT PHI"
+contact:
+  - affiliation: "KIT IQMT"
+    email: rotzinger@kit.edu
+    family-names: Rotzinger
+    given-names: Hannes
+title: "Qkit - a quantum measurement suite in python"
+version: 0.4.11
+date-released: 2024-12-16
+license: "GPU-2.0"
+url: "https://github.com/qkitgroup/qkit"

{qkit-0.5.0 → qkit-0.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: qkit
-Version: 0.5.0
+Version: 0.5.2
 Summary: qKIT quantum measurement suite in python
 Project-URL: Homepage, https://github.com/qkitgroup/qkit
 Project-URL: Bug Tracker, https://github.com/qkitgroup/qkit/issues
@@ -353,6 +353,7 @@ Classifier: Intended Audience :: Science/Research
 Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
 Classifier: Programming Language :: Python :: 3.7
 Requires-Python: >=3.7
+Requires-Dist: filelock>=3.17
 Requires-Dist: h5py>=3.8
 Requires-Dist: ipython
 Requires-Dist: numpy>=1.24
@@ -376,6 +377,8 @@ Provides-Extra: qgrid
 Requires-Dist: qgrid>=1.0; extra == 'qgrid'
 Provides-Extra: timedomain
 Requires-Dist: zerorpc>=0.6; extra == 'timedomain'
+Provides-Extra: url
+Requires-Dist: parsita~=2.2.2; extra == 'url'
 Provides-Extra: zurich-instruments
 Requires-Dist: zhinst~=23.2; extra == 'zurich-instruments'
 Description-Content-Type: text/markdown
@@ -417,7 +420,7 @@ If you can't put such a configuration file into a suitable location, you can set
 Installing qkit is a two step process: First you need to obtain the `qkit` package, and then you need to setup your system to use it properly. This guide will provide you with the required steps.
 
 ### Creating a Virtual Environment
-It is recommended to use a virtual environment. This isolates this local environment from your global packages. This way, version conflicts can be avoided. If you choose to use a virtual environment, then it needs to be activated, otherwise, qkit and its dependencies will not be available. This also means double click to open .h5 files will require configuration.
+It is mandatory to use a virtual environment if you want to use automatic installation. This isolates this local environment from your global packages. This way, version conflicts can be avoided. You need to activate the virtual environment before using qkit. Otherwise, qkit and its dependencies will not be available.
 
 **NOTE: WE DO NOT GUARANTEE COMPATIBILITY WITH ANACONDA/MINICONDA/CONDA! USE AT YOUR OWN RISK!**
 
@@ -445,6 +448,8 @@ Create a virtual environment, as described above. Then use pip to install qkit:
 pip install qkit[jupyter,analysis]
 ```
 
+If you are simply using qkit, changes to files in `src/` **should not** be necessary. If you find things you need to change there, this might be a bug. Please report this.
+
 #### Install `qkit` for development
 Clone this repository to wherever is convenient.
 ```bash
@@ -514,17 +519,6 @@ notebook_dir = r'C:\notebooks' # Change this line
 
 Also, you will need to migrate your local config to a parent directory of your notebooks, or point to it using the environment variable `QKIT_LOCAL_CONFIG`. It is possible to set this environment variable in `jupyter_lab_config.py`, as environment variables are inherited to process children.
 
-
-## Long Term Goal: Pip Installation (NOT YET WORKING)
-If you intend to actively work on the code, look at the section for developing this code.
-To install this package, run:
-```bash
-pip install 'qkit[jupyter,analysis] @ git+https://github.com/qkitgroup/qkit.git@master'
-```
-If you are simply using qkit, changes to files in `src/` **should not** be necessary. If you find things you need to change there, this might be a bug. Please report this.
-
-If you intend to use the option to click on .h5 files in order to open them, don't install qkit in a virtual environment.
-
 ## Requirements
 This project uses python. An up to date installation of python is expected to be present.
 | Library | Usage |

{qkit-0.5.0 → qkit-0.5.2}/README.md

@@ -35,7 +35,7 @@ If you can't put such a configuration file into a suitable location, you can set
 Installing qkit is a two step process: First you need to obtain the `qkit` package, and then you need to setup your system to use it properly. This guide will provide you with the required steps.
 
 ### Creating a Virtual Environment
-It is recommended to use a virtual environment. This isolates this local environment from your global packages. This way, version conflicts can be avoided. If you choose to use a virtual environment, then it needs to be activated, otherwise, qkit and its dependencies will not be available. This also means double click to open .h5 files will require configuration.
+It is mandatory to use a virtual environment if you want to use automatic installation. This isolates this local environment from your global packages. This way, version conflicts can be avoided. You need to activate the virtual environment before using qkit. Otherwise, qkit and its dependencies will not be available.
 
 **NOTE: WE DO NOT GUARANTEE COMPATIBILITY WITH ANACONDA/MINICONDA/CONDA! USE AT YOUR OWN RISK!**
 
@@ -63,6 +63,8 @@ Create a virtual environment, as described above. Then use pip to install qkit:
 pip install qkit[jupyter,analysis]
 ```
 
+If you are simply using qkit, changes to files in `src/` **should not** be necessary. If you find things you need to change there, this might be a bug. Please report this.
+
 #### Install `qkit` for development
 Clone this repository to wherever is convenient.
 ```bash
@@ -132,17 +134,6 @@ notebook_dir = r'C:\notebooks' # Change this line
 
 Also, you will need to migrate your local config to a parent directory of your notebooks, or point to it using the environment variable `QKIT_LOCAL_CONFIG`. It is possible to set this environment variable in `jupyter_lab_config.py`, as environment variables are inherited to process children.
 
-
-## Long Term Goal: Pip Installation (NOT YET WORKING)
-If you intend to actively work on the code, look at the section for developing this code.
-To install this package, run:
-```bash
-pip install 'qkit[jupyter,analysis] @ git+https://github.com/qkitgroup/qkit.git@master'
-```
-If you are simply using qkit, changes to files in `src/` **should not** be necessary. If you find things you need to change there, this might be a bug. Please report this.
-
-If you intend to use the option to click on .h5 files in order to open them, don't install qkit in a virtual environment.
-
 ## Requirements
 This project uses python. An up to date installation of python is expected to be present.
 | Library | Usage |

{qkit-0.5.0 → qkit-0.5.2}/pyproject.toml

@@ -31,13 +31,15 @@ dependencies = [
     "pyzmq>=25",
     "tomli>=2.0.1",
     "ipython",
-    "packaging"
+    "packaging",
+    "filelock>=3.17"
 ]
 
 [project.scripts]
 qviewkit = "qkit.gui.qviewkit.main:main"
 qkit-install = "qkit.install.install:main"
 qkit-manual-breadcrumbs = "qkit.core.lib.file_service.breadcrumbs:manual_index"
+qviewkit-url = "qkit.gui.plot.url_launcher:url_handler"
 
 [project.optional-dependencies] # Here goes stuff like qiclib
 jupyter = [
@@ -59,6 +61,9 @@ qgrid = [
 timedomain = [
     "zerorpc>=0.6"
 ]
+url = [
+    "parsita~=2.2.2"
+]
 
 
 [project.urls]
@@ -84,5 +89,10 @@ packages = ["src/qkit"]
 [tool.hatch.build.targets.sdist]
 exclude = ["data/*", "notebooks/*", "logs/*", "venv/*"]
 
+[tool.hatch.envs.hatch-test]
+extra-dependencies = [
+    "parsita~=2.2.2"
+]
+
 [tool.pytest.ini_options]
 testpaths="tests"

{qkit-0.5.0 → qkit-0.5.2}/src/qkit/__init__.py

@@ -12,9 +12,13 @@ for IntelliSense, making programming easier.
 from typing import TYPE_CHECKING
 if TYPE_CHECKING:
     from qkit.core.lib.file_service.file_info_database import fid as fid_class
+    from qkit.core.instrument_tools import Insttools
     from qkit.config.config_holder import ConfClass
-fid: 'fid_class'
-cfg: 'ConfClass'
+    from qkit.core.s_init.S16_available_modules import ModuleAvailable
+fid: 'fid_class'  # Initilaized in S80_load_file_service
+cfg: 'ConfClass'  # Initialized by lazy-loading in __getattr__ (see below)
+instruments: 'Insttools'
+module_available: 'ModuleAvailable'  # Initialized in S16_available_modules
 
 def __getattr__(name):
     """

qkit-0.5.2/src/qkit/_version.py

@@ -0,0 +1 @@
+__version__ = "0.5.2"

{qkit-0.5.0 → qkit-0.5.2}/src/qkit/core/lib/file_service/breadcrumbs.py

@@ -21,32 +21,66 @@ from pathlib import Path
 import qkit
 import os
 import itertools
+from filelock import FileLock, Timeout
+import logging
+
+log = logging.getLogger('breadcrumbs')
 
 FILE_END = ".breadcrumb"
+LOCK_EXTENSION = ".lock"
 
-def derive_breadcrumb_filename() -> Path:
+def derive_breadcrumb_filename(extension = FILE_END) -> Path:
     """
     Derive a machine-unique breadcrumb file name in the data-directory.
     """
     import uuid
     node = uuid.getnode()
-    filename = f".{node:x}{FILE_END}"
+    filename = f".{node:x}{extension}"
     return Path(qkit.cfg['datadir']) / filename
 
+def derive_breadcrumb_lock_file() -> Path:
+    """
+    Derive a machine-unique breadcrumb lock file name in the data-directory.
+    """
+    return derive_breadcrumb_filename(extension=FILE_END + LOCK_EXTENSION)
+
 class BreadCrumbCreator():
     """
     Manages creating the initial bread crumb file and updating it after each measurement.
+
+    Since only one writer can reliably write, we try to get a lock with a timeout.
+    With the lock acquired, we append our entry or clear the file.
     """
 
     def __init__(self) -> None:
         self._breadcrumb_path = derive_breadcrumb_filename()
-        if self._breadcrumb_path.exists():
-            os.remove(self._breadcrumb_path)
-        self._breadcrumb_file = open(self._breadcrumb_path, mode="w")
+        self._lock = FileLock(derive_breadcrumb_lock_file(), timeout=5)
+
+    def clear_file(self):
+        try:
+            with self._lock:
+                if self._breadcrumb_path.exists():
+                    os.remove(self._breadcrumb_path)
+        except Timeout:
+            log.error("Acquiring file lock timed out.")
+            raise
+        except OSError:
+            log.error("Could not acquire lock file for clearing breadcrumbs.")
+            raise
 
     def append_entry(self, uuid: str, path: Path|str):
         rel_path = Path(path).relative_to(self._breadcrumb_path.parent)
-        print(f"{uuid[:6]}={rel_path}", file=self._breadcrumb_file, flush=True) # Fails if uuid is not 6 digits
+        try:
+            with self._lock:
+                with open(self._breadcrumb_path, mode="a", encoding='utf-8') as breadcrumb_file:
+                    print(f"{uuid[:6]}={rel_path}", file=breadcrumb_file, flush=True) # Fails if uuid is not 6 digits
+        except Timeout:
+            log.error("Acquiring file lock timed out.")
+            raise
+        except OSError:
+            log.error("Could not acquire lock file for writing breadcrumb.")
+            raise
+            
 
 def read_breadcrumb(path: Path) -> dict[str, Path]:
     """
@@ -54,7 +88,7 @@ def read_breadcrumb(path: Path) -> dict[str, Path]:
     """
     breadcrumb_parent = path.parent
     uuid_map: dict[str, Path] = {}
-    with open(path, mode="r") as f:
+    with open(path, mode="r", encoding='utf-8') as f:
         for line in f.readlines():
             if line[6] == '=': # Valid format
                 uuid = line[:6]

{qkit-0.5.0 → qkit-0.5.2}/src/qkit/core/lib/file_service/file_info_database.py

@@ -189,6 +189,7 @@ class fid(file_system_service):
         self._h5_n_mtime = {}
         
         self._remove_cache_files()
+        self._breadcrumb_creator.clear_file()
         self.create_database()
 
     def update_all(self):

{qkit-0.5.0 → qkit-0.5.2}/src/qkit/core/s_init/S16_available_modules.py

@@ -6,7 +6,7 @@ and check for commonly used libraries.
 """
 
 import qkit
-from pkgutil import find_loader
+from importlib.util import find_spec
 
 
 class ModuleAvailable:
@@ -23,7 +23,7 @@ class ModuleAvailable:
     
     def module_available(self, module_name):
         if module_name not in self.available_modules:
-            self.available_modules[module_name] = bool(find_loader(module_name))
+            self.available_modules[module_name] = bool(find_spec(module_name))
         return self.available_modules[module_name]
     
     def __call__(self, module_name):

qkit-0.5.2/src/qkit/drivers/BKPrecision_9242.py

@@ -0,0 +1,410 @@
+# BKPrecision_9242.py driver for BK Precision 9242  DC voltag/current source
+# adapted from Yokogawa GS200 driver, Sergei Masis @KIT 06/2025
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+from qkit.core.instrument_base import Instrument
+from qkit import visa
+import logging
+import numpy
+import struct
+import time
+from distutils.version import LooseVersion
+
+class BKPrecision_9242(Instrument):
+    '''
+    This is the driver for the BK Precision 9242  DC voltage/current source
+
+    Usage:
+    Initialize with
+    <name> = instruments.create('<name>', 'BKPrecision_9242', address='<GBIP address>',
+        reset=<bool>)
+    '''
+
+    def __init__(self, name, address, reset=False):
+        '''
+        Initializes the BK Precision 9242, and communicates with the wrapper.
+
+        Input:
+            name (string)    : name of the instrument
+            address (string) : GPIB address
+            reset (bool)     : resets to default values
+
+        Output:
+            None
+        '''
+        # Initialize wrapper functions
+        logging.info(__name__ + ' : Initializing instrument BK Precision 9242')
+        Instrument.__init__(self, name, tags=['physical'])
+        
+        # Add some global constants
+        self._address = address
+        self._visainstrument = visa.instrument(self._address)
+        
+        # Set termination characters (nessecarry for Ethernet communication)
+        if  LooseVersion(visa.__version__) < LooseVersion("1.5.0"):            # pyvisa 1.4
+            self._visainstrument.term_chars = ''
+        else:                                                                  # pyvisa 1.8
+            self._visainstrument.read_termination  = ''
+            self._visainstrument.write_termination = ''
+
+        # Add parameters to wrapper
+
+#        self.add_parameter('source_function',
+#            flags=Instrument.FLAG_GETSET | Instrument.FLAG_GET_AFTER_SET,
+#            type=str, units='')
+
+#        
+#        self.add_parameter('operation_mode',
+#            flags=Instrument.FLAG_SET,
+#            type=str, units='')
+
+#        self.add_parameter('source_mode',
+#            flags=Instrument.FLAG_GETSET,
+#            type=str, units='')
+
+        self.add_parameter('current_protection',
+            flags=Instrument.FLAG_GETSET ,
+            units='', type=str)
+           
+        self.add_parameter('output',
+            flags=Instrument.FLAG_GETSET ,
+            units='', type=str)
+        
+        self.add_parameter('current', 
+            flags=Instrument.FLAG_GETSET,
+            type=float, units='')
+
+#        self.add_parameter('voltage_protection', 
+#            flags=Instrument.FLAG_GETSET | Instrument.FLAG_GET_AFTER_SET,
+#            type=float, units='V')
+#
+#        self.add_parameter('current_protection', 
+#            flags=Instrument.FLAG_GETSET | Instrument.FLAG_GET_AFTER_SET,
+#            type=float, units='A')
+#            
+#        self.add_parameter('4W',
+#            flags=Instrument.FLAG_GETSET ,
+#            units='', type=str)
+#
+#        self.add_parameter('ramp_wait_time', 
+#            flags=Instrument.FLAG_GET,
+#            type=float, units = 's')
+
+        # Add functions to wrapper
+        
+        self.add_function('reset')
+        self.add_function('get_all')
+        #self.add_function('set_range_auto')
+        self.add_function('set_defaults')
+        self.add_function('ramp_current')
+        #self.add_function('ramp_ch2_current')
+
+        
+        if reset:
+            self.reset()
+        else:
+            self.get_all()
+            #self.set_defaults()
+
+# functions
+    def __del__(self):
+        self.close_connection()
+        print("Session closed.")
+        
+    def close_connection(self):
+        """
+        Closes the VISA-instrument to disconnect the instrument.
+
+        Parameters
+        ----------
+                None
+
+        Returns
+        -------
+                None
+        """
+        try:
+            logging.info(
+                __name__
+                + " : Closing connection to QDAC-II server {:s}".format(self._address)
+            )
+            self._visainstrument.close()
+        except Exception as e:
+            logging.error("{!s}: Cannot close VISA-instrument".format(__name__))
+            raise type(e)(
+                "{!s}: Cannot close VISA-instrument\n{!s}".format(__name__, e)
+            )
+        return
+            
+    def reset(self):     
+        '''
+        Resets instrument to default values
+
+        Input:
+            None
+    
+        Output:
+            None
+        '''
+        logging.debug(__name__ + ' : Resetting instrument')
+        self._write('*RST')
+        self.get_all()
+      
+    def get_all(self):
+        '''
+        Reads all relevant parameters from instrument
+
+        Input:
+            None
+
+        Output:
+            None
+        '''
+        logging.debug(__name__ + ' : Get all relevant data from device')
+        
+        #self._ask(':outp?')
+        
+        
+        #self.get_sync()
+        #self.get('source_function')
+        
+        #self.get_sync()
+        
+
+
+#        self.get('sense_range')
+#        self.get('sense_mode')
+#        self.get('source_trig')
+#        self.get('sense_trig')
+#        self.get('source_delay')
+#        self.get('sense_delay')
+#        self.get('4W')
+        #self.get('level')
+#        self.get('output')
+           
+    def do_get_output(self):
+        '''
+        Gets output state
+        '''
+        logging.debug('Get status of output')
+        ans = self._ask(':outp?')
+        
+        if int(ans):
+            print('Attention: Output is set on; Be careful!')      #warning if output is on! No fast current changes if coil is attached
+            return 'on'
+        else:
+            return 'off'
+        
+    def do_set_output(self, val):
+        '''
+        Sets outputs of channels in "on" or "off" position.
+        
+        '''
+        if val in ['on','off']:
+            logging.debug('Set output to %s' % val)
+            self._write(':outp:stat %s' % val)
+        else:
+            logging.error('Invalid value %s' % val)
+    
+       
+    def set_defaults(self):
+        
+        '''
+        Set to driver defaults:
+            
+            TODO
+
+        '''
+        
+#        self._write(':syst:beep 0')
+#        self.set_source_mode('curr')
+#        self.set('current_protection', '10e-3')
+        
+        
+#        self.set('4W', 'off')
+
+#        self.set('sense_mode', 'volt')
+#        self.set('sense_range', '200mV')
+#        self.set('source_delay', 15e-6)
+#        self.set('sense_delay', 0.3)
+#        self.set('source_trig', 'ext')
+#        self.set('sense_trig', 'sour')
+    
+
+#        
+# # parameters
+
+    def do_set_current_protection(self, val):
+        '''
+        sets current protection
+         
+        Input:
+            val (string)  :
+        
+        Output:
+        
+        '''
+        logging.debug('Set current protection to %s' % val)
+        self._set_func_par_value('curr', 'prot', val)
+       
+       
+
+    def do_get_current_protection(self):
+        '''
+        Get current protection
+        '''
+        logging.debug('Get current protection')
+        return self._get_func_par('curr', 'prot')
+
+    def do_set_voltage_protection(self, val):
+        '''
+        sets voltage protection
+         
+        Input:
+            val (string)  :
+               
+        Output:
+        
+        '''
+        logging.debug('Set voltage protection to %s' % val)
+        self._set_func_par_value('volt', 'prot', val)
+       
+       
+
+    def do_get_voltage_protection(self):
+        '''
+        Get voltage protection
+        '''
+        logging.debug('Get voltage protection')
+        return self._get_func_par('volt', 'prot')
+
+
+    def do_set_current(self, val):
+        '''
+        Set current 
+        '''
+        logging.debug('Set current')   
+        self._write(':curr %s' % val)
+        
+    def do_get_current(self):
+        '''
+        Get current
+        '''
+        logging.debug('Get current')
+        return self._ask(':curr?')
+
+    def do_set_voltage(self, val):
+        '''
+        Set voltage
+        '''
+        logging.debug('Set voltage')   
+        self._write(':volt %s' % val)
+        
+    def do_get_voltage(self):
+        '''
+        Get current
+        '''
+        logging.debug('Get voltage')
+        return self._ask(':volt?')
+                
+
+    def ramp_current(self,target, step, wait=0.1, showvalue=False):
+        
+        '''
+        Ramps the current starting from the actual value to a target value
+        Attention: all values are given in A
+        'step' determines the step size
+        'wait' determines the sleep time after every step
+        'showvalue' print current value - default is False
+        '''
+        
+        start = self.get_current()
+        if showvalue==True: print("{:g}mA".format(round(start*1e3, 3)))
+        
+        if(target < start): step = -step
+        a = numpy.concatenate( (numpy.arange(start, target, step)[1:], [target]) )
+        for i in a:
+            if showvalue==True: print("{:g}mA".format(round(i*1e3, 3)), end=" ")
+            self.set_current(i)
+            time.sleep(wait)
+            
+# core communication
+  
+    def _write(self, msg):
+        
+        '''
+        Sends a visa command <msg>
+        
+        Input:
+            msg (str)
+        Output:
+            None
+        '''
+        return self._visainstrument.write(msg)
+    
+    
+    def _ask(self, msg):
+        '''
+        Sends a visa command <msg> and returns the read answer <ans>
+        
+        Input:
+            msg (str)
+        Output:
+            ans (str)
+        '''
+        return self._visainstrument.query(msg).rstrip()
+        
+        
+        
+    def _set_func_par_value(self, func, par, val):
+        '''
+        For internal use only!!
+        Changes the value of the parameter for the function specified
+        
+        Input:
+            ch (int)
+            func (string) :
+            par (string)  :
+            val (depends) :
+        
+        Output:
+            None
+        '''
+        string = ':%s:%s %s' %(func, par, val)
+        logging.debug(__name__ + ' : Set instrument to %s' % string)
+        self._visainstrument.write(string)
+       
+       
+
+    def _get_func_par(self, func, par):
+        '''
+        For internal use only!!
+        Reads the value of the parameter for the function specified
+        from the instrument
+        
+        Input:
+            ch (int)      :
+            func (string) :
+            par (string)  :
+        
+        Output:
+            val (string) :
+        '''
+        string = ':%s:%s?' %(func, par)
+        ans = self._visainstrument.query(string)
+        logging.debug(__name__ + ' : ask instrument for %s (result %s)' % \
+            (string, ans))
+        return ans.lower()