Minor Fixes

Author: Sampreet

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## v0.9.0 - 2023/01/29 - 00 - Minor Fixes
+* Updated documentation of `qom.systems.BaseSystem` and `qom.ui.axes.BaseAxis` modules.
+* Minor fixes for 3D plot linewidths in `qom.ui.plotters.MPLPlotter` module.
+* Minor fixes to parellel instances in `qom.utils.looper` module.
+* Minor updates to docsources.
+
 ## v0.9.0 - 2022/11/08 - 00 - Multiprocessing Support
 * Updated `qom.loopers.BaseLooper` module:
     * Added process variables to support object multiprocessing.

docs/source/conf.py

@@ -17,8 +17,8 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'Quantum Optomechanics Toolbox'
-copyright = '2020, Sampreet Kalita'
+project = 'The Quantum Optomechanics Toolbox'
+copyright = '2023, Sampreet Kalita'
 author = 'Sampreet Kalita'
 
 

docs/source/index.rst

@@ -1,8 +1,8 @@
 .. Quantum Optomechanics Toolbox documentation master file, created by
    sphinx-quickstart on Fri Dec  4 15:06:12 2020.
 
-Welcome to the Documentation!
-=============================
+Welcome to the ``qom-v0.9.0`` Documentation!
+============================================
 
 The Quantum Optomechanics Toolbox (packaged as ``qom``) is a wrapper-styled, scalable toolbox featuring multiple modules for the calculation of stationary as well as dynamical properties of many-body quantum optomechanical systems. 
 Its inheritable system classes can also be used to study other systems that follow the optomechanical model.

qom/systems/BaseSystem.py

@@ -6,7 +6,7 @@
 __name__    = 'qom.systems.BaseSystem'
 __authors__ = ['Sampreet Kalita']
 __created__ = '2020-12-04'
-__updated__ = '2022-09-18'
+__updated__ = '2022-11-26'
 
 # dependencies
 from typing import Union
@@ -99,15 +99,15 @@ class BaseSystem():
 
     Some methods require one or more of the following predefined callables to work properly:
         ======================  ================================================
-        callable                purpose
+        callable                returns
         ======================  ================================================
-        func_ode                function returning the rate equations of the classical mode amplitudes and quantum correlations, formatted as ``func_ode(t, v, c)``, where ``t`` is the time at which the integration is performed, ``v`` is a list of the amplitudes and fluctuations and ``c`` is a list of constant parameters. The output should match the dimension of ``v``. If ``func_ode_corrs`` parameter is given, this function is treated as the function for the modes only.
-        func_ode_corrs          function returning rate equations of the quantum correlations. It follows the same formatting as ``func_ode``.
-        get_A                   function to obtain the drift matrix, formatted as ``get_A(modes, params, t)``, where ``modes`` are the modes amplitudes at time ``t`` and ``params`` are the constant parameters of the system. Returns the drift matrix ``A``.
-        get_ivc                 function to obtain the initial values and constants, formatted as ``get_ivc()``. Returns values ``iv`` and ``c`` for the initial values and constants respectively.
-        get_mode_rates          function to obtain the rate of the classical mode amplitudes for a given list of modes, formatted as ``get_mode_rates(modes, params, t)``, where ``modes`` are the modes amplitudes at time ``t`` and ``params`` are the constant parameters of the system. Returns the mode rates with same dimension as ``modes``.
-        get_oss_args            function to obtain the required parameters to calculate the optical steady state, formatted as ``get_oss_args(params)``, where ``params`` are the constant parameters of the system. 
-        get_oss_modes           function to obtain the classical mode amplitudes from the mean optical occupancy, formatted as ``get_oss_modes(params)``, where ``params`` are the constant parameters of the system. Returns the list of modes calculated for each mean optical occupancy.
+        func_ode                the rate equations of the classical mode amplitudes and quantum correlations, formatted as ``func_ode(t, v, c)``, where ``t`` is the time at which the integration is performed, ``v`` is a list of the amplitudes and fluctuations and ``c`` is a list of constant parameters. The output should match the dimension of ``v``. If ``func_ode_corrs`` parameter is given, this function is treated as the function for the modes only.
+        func_ode_corrs          the rate equations of the quantum correlations. It follows the same formatting as ``func_ode``.
+        get_A                   the drift matrix, formatted as ``get_A(modes, params, t)``, where ``modes`` are the modes amplitudes at time ``t`` and ``params`` are the constant parameters of the system. Returns the drift matrix ``A``.
+        get_ivc                 the initial values and constants, formatted as ``get_ivc()``. Returns values ``iv`` and ``c`` for the initial values and constants respectively.
+        get_mode_rates          the rates of the classical mode amplitudes, formatted as ``get_mode_rates(modes, params, t)``, where ``modes`` are the modes amplitudes at time ``t`` and ``params`` are the constant parameters of the system. Returns the mode rates with same dimension as ``modes``.
+        get_oss_args            the parameters required to calculate the optical steady states, formatted as ``get_oss_args(params)``, where ``params`` are the constant parameters of the system. 
+        get_oss_modes           the steady state classical mode amplitudes from the mean optical occupancies, formatted as ``get_oss_modes(params)``, where ``params`` are the constant parameters of the system. Returns the list of modes calculated for each mean optical occupancy.
         ======================  ================================================
 
     The ``get_oss_args`` function should return the following values in order:

qom/ui/axes/BaseAxis.py

@@ -31,21 +31,21 @@ class BaseAxis():
         Values for the axis supporting a list of values or a dictionary containing the range of values with keys "min", "max", "dim" and "scale" or the values themselves under key "val".
     plotter_params : dict
         Parameters for the plotter. Currently supported keys are:
-            ==============  ====================================================
-            key             value
-            ==============  ====================================================
-            "label"         (*str*) text of the axis label.
-            "label_color"   (*str*) color of the axis label.
-            "label_pad"     (*int*) padding of the axis label.
-            "limits"        (*list*) minimum and maximum limits for the axis.
-            "scale"         (*str*) step scale for the values. Options are "linear" and "log".
-            "tick_dim"      (*float*) dimension of the ticks.
-            "tick_labels"   (*list*) tick labels of the plots.
-            "tick_pad"      (*int*) padding of the tick labels.
-            "tick_position" (*str*) position of ticks on the plot. Options are "both", "bottom", "left", "right" or "top".
-            "ticks"         (*list*) ticks of the plots.
-            "ticks_minor"   (*list*) positions of minor ticks of the plots.
-            ==============  ====================================================
+            ================    ================================================
+            key                 value
+            ================    ================================================
+            "label"             (*str*) text of the axis label.
+            "label_color"       (*str*) color of the axis label.
+            "label_pad"         (*int*) padding of the axis label.
+            "limits"            (*list*) minimum and maximum limits for the axis.
+            "scale"             (*str*) step scale for the values. Options are "linear" and "log".
+            "tick_dim"          (*float*) dimension of the ticks.
+            "tick_labels"       (*list*) tick labels of the plots.
+            "tick_pad"          (*int*) padding of the tick labels.
+            "tick_position"     (*str*) position of ticks on the plot. Options are "both", "bottom", "left", "right" or "top".
+            "ticks"             (*list*) ticks of the plots.
+            "ticks_minor"       (*list*) positions of minor ticks of the plots.
+            ================    ================================================
     """
 
     # attributes

qom/ui/plotters/MPLPlotter.py

@@ -6,7 +6,7 @@
 __name__    = 'qom.ui.plotters.MPLPlotter'
 __authors__ = ['Sampreet Kalita']
 __created__ = '2020-10-03'
-__updated__ = '2022-11-04'
+__updated__ = '2023-01-29'
 
 # dependencies
 from matplotlib.colors import LinearSegmentedColormap, Normalize
@@ -354,6 +354,20 @@ def _resize_plot(self, width: float=4.8, height: float=4.8):
         if _min < 4.0:
             _min = 4.0
 
+        # update 3D axes
+        if self.params['type'] in self.types_3D:
+            _mpl_axes = plt.gca()
+            _axes = [_mpl_axes.xaxis, _mpl_axes.yaxis, _mpl_axes.zaxis]
+            for _ax in _axes:
+                _ax._axinfo['tick'].update({
+                    'linewidth': {
+                        True: _min / 5.0,
+                        False: _min / 20.0
+                    },
+                    'inward_factor': _min / 20.0
+                })
+                # _ax.set_tick_params(length=_min, width=_min / 5.0, which='major')
+                # _ax.set_tick_params(length=_min / 2.0, width=_min / 5.0, which='minor')
         # update all axes
         for _ax in plt.gcf().get_axes():
             # update spines

qom/utils/looper.py

@@ -10,12 +10,12 @@
 import os
 import time
 
-"""Module for utility functions to wrap subpackages."""
+"""Module containing utility functions for loopers."""
 
 __name__    = 'qom.utils.looper'
 __authors__ = ['Sampreet Kalita']
 __created__ = '2021-05-25'
-__updated__ = '2022-09-19'
+__updated__ = '2023-01-29'
 
 # qom modules
 from ..ui import init_log
@@ -125,106 +125,6 @@ def func_params(system_params, val, logger, results):
 
     return func
 
-def wrap_looper(SystemClass, params: dict, func, looper, file_path_prefix: str=None, plot: bool=False, hold: bool=True, width: float=5.0, height: float=5.0, parallel=False, p_start=time.time(), p_index=0):
-    """Function to wrap loopers.
-
-    Requires already defined callables ``func_ode``, ``get_mode_rates``, ``get_ivc``, ``get_A`` and ``get_oss_args`` inside the system class.
-    
-    Parameters
-    ----------
-    SystemClass : :class:`qom.systems.*`
-        Class containing the system.
-    params : dict
-        All parameters as defined in :class:`qom.loopers.BaseLooper`.
-    func : str or callable
-        Code of the function or the function to loop, following the format defined in :class:`qom.loopers.BaseLooper`. Available function codes are:
-            ==============  ================================================
-            value           meaning
-            ==============  ================================================
-            "aes"           averaged eigenvalue of the drift matrix.
-            "cad"           classical amplitude difference.
-            "cpd"           classical phase difference.
-            "les"           Lyapunov exponents.
-            "mav"           measure averages (fallback).
-            "mdy"           measure dynamics.
-            "moo"           mean optical occupancies.
-            "mss"           stationary measure.
-            "osz"           optical stability zone.
-            "pcc"           Pearson correlation factor.
-            ==============  ================================================
-    looper : str
-        Code of the looper. Available options are:
-            ==============  ================================================
-            value           meaning
-            ==============  ================================================
-            "XLooper"       1D looper (:class:`qom.loopers.XLooper`) (fallback).
-            "XYLooper"      2D looper (:class:`qom.loopers.XYLooper`).
-            "XYZLooper"     3D looper (:class:`qom.loopers.XYZLooper`).
-            ==============  ================================================
-    file_path_prefix : str, optional
-        Prefix of the file path.
-    plot: bool, optional
-        Option to plot the results.
-    hold : bool, optional
-        Option to hold the plot.
-    width : float, optional
-        Width of the figure.
-    height : float, optional
-        Height of the figure.
-    parallel : bool, optional
-        Option to format outputs when the looper is run in parallel.
-    p_start : float, optional
-        Time at which the process was started. If `None`, the value is initialized to current time.
-    p_index : int, optional
-        Index of the process.
-
-    Returns
-    -------
-    looper : :class:`qom.loopers.*`
-        Instance of the looper.
-    """
-
-    # initialize logger
-    init_log(parallel=parallel)
-
-    # select function
-    if type(func) is str:
-        func = get_looper_func(SystemClass=SystemClass, solver_params=params.get('solver', {}), func_code=func)
-
-    # select looper
-    if type(looper) is str:
-        if looper == 'XYLooper':
-            looper = XYLooper(func=func, params=copy.deepcopy(params), parallel=parallel, p_start=p_start, p_index=p_index)
-        elif looper == 'XYZLooper':
-            looper = XYZLooper(func=func, params=copy.deepcopy(params), parallel=parallel, p_start=p_start, p_index=p_index)
-        else:
-            looper = XLooper(func=func, params=copy.deepcopy(params), parallel=parallel, p_start=p_start, p_index=p_index)
-
-    # wrap looper
-    looper.wrap(file_path_prefix=file_path_prefix, plot=plot, hold=hold, width=width, height=height)
-
-    return looper
-
-def run_wrap_looper_instance(args):
-    '''Function to run a single instance of `wrap_looper`.
-    
-    Parameters
-    ----------
-    args : list
-        Arguments of the `wrap_looper` function.
-
-    Returns
-    -------
-    looper : :class:`qom.loopers.*`
-        Instance of the looper.
-    '''
-
-    # extract arguments
-    SystemClass, params, func, looper, file_path_prefix, plot, hold, width, height, parallel, p_start, p_index = args
-
-    # return instance
-    return wrap_looper(SystemClass=SystemClass, params=params, func=func, looper=looper, file_path_prefix=file_path_prefix, plot=plot, hold=hold, width=width, height=height, parallel=parallel, p_start=p_start, p_index=p_index)
-
 def run_loopers_in_parallel(SystemClass, params: dict, func, looper, file_path_prefix: str=None, plot: bool=False, hold: bool=True, width: float=5.0, height: float=5.0, num_loopers: int=None):
     """Function to wrap loopers.
 
@@ -281,7 +181,7 @@ def run_loopers_in_parallel(SystemClass, params: dict, func, looper, file_path_p
     if 'XYZ' in looper:
         looper = XYZLooper(func=func, params=params, parallel=True)
         axis = 'Z'
-    if 'XY' in looper:
+    elif 'XY' in looper:
         looper = XYLooper(func=func, params=params, parallel=True)
         axis = 'Y'
     else:
@@ -365,4 +265,104 @@ def run_loopers_in_parallel(SystemClass, params: dict, func, looper, file_path_p
     if plot:
         looper.plot_results(hold=hold, width=width, height=height)
 
+    return looper
+
+def run_wrap_looper_instance(args):
+    '''Function to run a single instance of `wrap_looper`.
+    
+    Parameters
+    ----------
+    args : list
+        Arguments of the `wrap_looper` function.
+
+    Returns
+    -------
+    looper : :class:`qom.loopers.*`
+        Instance of the looper.
+    '''
+
+    # extract arguments
+    SystemClass, params, func, looper, file_path_prefix, plot, hold, width, height, parallel, p_start, p_index = args
+
+    # return instance
+    return wrap_looper(SystemClass=SystemClass, params=params, func=func, looper=looper, file_path_prefix=file_path_prefix, plot=plot, hold=hold, width=width, height=height, parallel=parallel, p_start=p_start, p_index=p_index)
+
+def wrap_looper(SystemClass, params: dict, func, looper, file_path_prefix: str=None, plot: bool=False, hold: bool=True, width: float=5.0, height: float=5.0, parallel=False, p_start=time.time(), p_index=0):
+    """Function to wrap loopers.
+
+    Requires already defined callables ``func_ode``, ``get_mode_rates``, ``get_ivc``, ``get_A`` and ``get_oss_args`` inside the system class.
+    
+    Parameters
+    ----------
+    SystemClass : :class:`qom.systems.*`
+        Class containing the system.
+    params : dict
+        All parameters as defined in :class:`qom.loopers.BaseLooper`.
+    func : str or callable
+        Code of the function or the function to loop, following the format defined in :class:`qom.loopers.BaseLooper`. Available function codes are:
+            ==============  ================================================
+            value           meaning
+            ==============  ================================================
+            "aes"           averaged eigenvalue of the drift matrix.
+            "cad"           classical amplitude difference.
+            "cpd"           classical phase difference.
+            "les"           Lyapunov exponents.
+            "mav"           measure averages (fallback).
+            "mdy"           measure dynamics.
+            "moo"           mean optical occupancies.
+            "mss"           stationary measure.
+            "osz"           optical stability zone.
+            "pcc"           Pearson correlation factor.
+            ==============  ================================================
+    looper : str
+        Code of the looper. Available options are:
+            ==============  ================================================
+            value           meaning
+            ==============  ================================================
+            "XLooper"       1D looper (:class:`qom.loopers.XLooper`) (fallback).
+            "XYLooper"      2D looper (:class:`qom.loopers.XYLooper`).
+            "XYZLooper"     3D looper (:class:`qom.loopers.XYZLooper`).
+            ==============  ================================================
+    file_path_prefix : str, optional
+        Prefix of the file path.
+    plot: bool, optional
+        Option to plot the results.
+    hold : bool, optional
+        Option to hold the plot.
+    width : float, optional
+        Width of the figure.
+    height : float, optional
+        Height of the figure.
+    parallel : bool, optional
+        Option to format outputs when the looper is run in parallel.
+    p_start : float, optional
+        Time at which the process was started. If `None`, the value is initialized to current time.
+    p_index : int, optional
+        Index of the process.
+
+    Returns
+    -------
+    looper : :class:`qom.loopers.*`
+        Instance of the looper.
+    """
+
+    # initialize logger
+    init_log(parallel=parallel)
+
+    # select function
+    if type(func) is str:
+        func = get_looper_func(SystemClass=SystemClass, solver_params=params.get('solver', {}), func_code=func)
+
+    # select looper
+    if type(looper) is str:
+        if looper == 'XYLooper':
+            looper = XYLooper(func=func, params=copy.deepcopy(params), parallel=parallel, p_start=p_start, p_index=p_index)
+        elif looper == 'XYZLooper':
+            looper = XYZLooper(func=func, params=copy.deepcopy(params), parallel=parallel, p_start=p_start, p_index=p_index)
+        else:
+            looper = XLooper(func=func, params=copy.deepcopy(params), parallel=parallel, p_start=p_start, p_index=p_index)
+
+    # wrap looper
+    looper.wrap(file_path_prefix=file_path_prefix, plot=plot, hold=hold, width=width, height=height)
+
     return looper