MCQT Solver and Two-mode Wigner

Author: Sampreet

CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## v1.0.1 - 2023/10/04 - 00 - MCQT Solver and Two-mode Wigner
+* Minor fixes to `qom.solvers.deterministic` module.
+* Updated `qom.solvers.measure` module:
+    * Added support for two-mode Wigner distribution.
+    * Minor fixes to single-mode Wigner distribution.
+* Added `qom.solvers.deterministic` module with the `MCQTSolver` class for Monte-Carlo quantum trajectories.
+* Updated `qom.ui.plotters` package:
+    * Added support for legend range selection in `base` module.
+    * Added option to import legend from Y-axis data in `matplotlib` module.
+    * Added option for z-order of scatter plots in `matplotlib` module.
+* Added parallelization support for Monte-Carlo quantum trajectories solver in `qom.utils.solvers` module.
+* Added `qom.misc` module for operators and state vectors.
+* Minor fixes to `qom.io` module.
+* Updated logging for all modules.
+* Updated documentation.
+* Updated `README`.
+
 ## v1.0.0 - 2023/07/20 - 00 - Updated README
 * Updated `docs/source/index`.
 * Removed `pyproject.toml`.

CITATION.bib

@@ -1,11 +1,15 @@
 @inproceedings{ICICT.2023.315
-    title = {The QOM Toolbox: An object-oriented Python framework for cavity optomechanical systems},
+    title = {The QOM Toolbox: An Object-oriented Python Framework for Cavity Optomechanical Systems},
     author = {Kalita, Sampreet and Sarma, Amarendra K.},
     booktitle = {Proceedings of Eighth International Congress on Information and Communication Technology},
-    year = {2023},
-    volume = {3},
-    number = {1},
+    editor = {Yang, Xin-She and Sherratt, R. Simon and Dey, Nilanjan and Joshi, Amit},
     series = {Lecture Notes in Networks and Systems},
-    publisher = {Springer Singapore},
-    url = {https://link.springer.com/book/9789819930449}
+    year = {2023},
+    month = {July},
+    volume = {694},
+    pages = {581--590},
+    publisher = {Springer Nature Singapore},
+    doi = {10.1007/978-981-99-3091-3_48},
+    isbn = {978-981-99-3091-3},
+    url = {https://link.springer.com/chapter/10.1007/978-981-99-3091-3_48}
 }

README.md

@@ -1,9 +1,9 @@
 # The Quantum Optomechanics Toolbox
 
-![Latest Version](https://img.shields.io/badge/version-1.0.0-red?style=for-the-badge)
+![Latest Version](https://img.shields.io/badge/version-1.0.1-red?style=for-the-badge)
 [![Last Commit](https://img.shields.io/github/last-commit/sampreet/qom?style=for-the-badge)](https://github.com/sampreet/qom/blob/master/CHANGELOG.md)
 
-[![Last Release](https://img.shields.io/github/release-date/sampreet/qom?style=flat-square&label=Last%20Release)](https://github.com/sampreet/qom/releases/tag/v0.9.0)
+[![Last Release](https://img.shields.io/github/release-date/sampreet/qom?style=flat-square&label=Last%20Release)](https://github.com/sampreet/qom/releases/tag/v1.0.1)
 [![Open Issues](https://img.shields.io/github/issues-raw/sampreet/qom?style=flat-square)](https://github.com/sampreet/qom/issues?q=is%3Aopen+is%3Aissue)
 [![Closed Issues](https://img.shields.io/github/issues-closed-raw/sampreet/qom?style=flat-square)](https://github.com/sampreet/qom/issues?q=is%3Aissue+is%3Aclosed)
 
@@ -29,12 +29,12 @@ Backed by numerical libraries like NumPy and SciPy, and featuring the highly cus
 | ![Stability](./docs/images/00_00_sz.png) | ![Correlations](./docs/images/00_01_en.png) |
 | Runtimes for the calculation of dynamical stability of the steady state using the Routh-Hurwitz criteria. | Runtimes for the calculation of average entanglement from the dynamical values of modes and correlations. |
 
-### Up Next!
+* Faster Monte-Carlo quantum trajectories solver for low-dimensional Hilbert spaces.
 
 | Monte-Carlo Quantum Trajectories | 
 |---|
 | ![Stability](./docs/images/00_02_mcqt.png) |
-| Comparison of runtimes for the Jaynes-Cummings Hamiltonian. |
+| Comparison of runtimes for the Jaynes-Cummings Hamiltonian with Hilbert space dimension of 10. |
 
 ## Examples
 
@@ -63,7 +63,7 @@ Backed by numerical libraries like NumPy and SciPy, and featuring the highly cus
 | ![Wigner](./docs/images/05_00_wigner.gif) | ![Soliton](./docs/images/05_01_soliton.gif) |
 | Wigner distribution depicting the evolution of mechanical squeezing in a modulated optomechanical system. | Soliton propagation in an array of optomechanical systems at different phase lags between the input solitons. |
 
-A set of notebooks and scripts to demonstrate the usage of the toolbox can be found [here](https://github.com/sampreet/qom-examples).
+A set of notebooks and scripts to demonstrate the usage of the toolbox can be found in the [examples repository](https://github.com/sampreet/qom-examples).
 
 ## Installation
 
@@ -86,7 +86,9 @@ conda install matplotlib numpy scipy sympy seaborn
 
 ***Note: To run the GUI modules, `pyqt` should be installed separately.***
 
-Once the dependencies are installed, the toolbox can be installed via PyPI (last release: v0.9.0) or locally (latest version: v1.0.0).
+Once the dependencies are installed, the toolbox can be installed via PyPI or locally.
+
+The documentation of the latest release is available [here](https://sampreet.github.io/qom-docs).
 
 ### Installing via PyPI
 
@@ -96,19 +98,15 @@ To install the last release via the Python Package Index, execute:
 pip install -i https://test.pypi.org/simple/ qom
 ```
 
-The corresponding documentation is available [here](https://sampreet.github.io/qom-docs/v0.9.0).
-
 ### Installing Locally
 
 To install the latest version locally, download the repository as `.zip` and extract the contents.
-Now, execute the following from *outside* the top-level directory, `ROOT_DIR`, inside which `setup.py` is located (refer to the file structure [here](./CONTRIBUTING.md)):
+Now, execute the following from *outside* the top-level directory, `ROOT_DIR`, inside which `setup.py` is located (refer to the [file structure](./CONTRIBUTING.md)):
 
 ```bash
 pip install -e ROOT_DIR
 ```
 
-The corresponding documentation is available [here](https://sampreet.github.io/qom-docs).
-
 ## Basic Usage
 
 The library features easy-to-use functions to calculate as well as visualize the trend of several quantum signatures.
@@ -222,4 +220,4 @@ Also, make sure you adhere to the [code of conduct](./CODE_OF_CONDUCT.md).
 
 ## Citing
 
-Please cite [S. Kalita and A. K. Sarma, *The QOM Toolbox: An object-oriented Python framework for cavity optomechanical systems*, Proceedings of Eighth International Congress on Information and Communication Technology **3**, Springer Singapore (2023)](./CITATION.bib) if you use our work in your research.
+Please cite [S. Kalita and A. K. Sarma, *The QOM Toolbox: An Object-oriented Python Framework for Cavity Optomechanical Systems*, Proceedings of Eighth International Congress on Information and Communication Technology, Lecture Notes in Networks and Systems, Volume 694, 581-590, Springer Nature Singapore (2023)](./CITATION.bib) if you use our work in your research.

docs/images/00_02_mcqt.png

@@ -1,7 +1,7 @@
 .. Quantum Optomechanics Toolbox documentation master file, created by
    sphinx-quickstart on Fri Dec 4 15:06:12 2020.
 
-Welcome to the ``qom-v1.0.0`` Documentation!
+Welcome to the ``qom-v1.0.1`` 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.
@@ -32,16 +32,15 @@ What's New in v1.0!
    * - Runtimes for the calculation of dynamical stability of the steady state using the Routh-Hurwitz criteria.
      - Runtimes for the calculation of average entanglement from the dynamical values of modes and correlations.
 
-Up Next!
---------
+* Faster Monte-Carlo quantum trajectories solver for low-dimensional Hilbert spaces.
 
 .. list-table::
    :widths: 100
    :header-rows: 1
 
    * - Monte-Carlo Quantum Trajectories
    * - .. image:: ../images/00_02_mcqt.png
-   * - Comparison of runtimes for the Jaynes-Cummings Hamiltonian.
+   * - Comparison of runtimes for the Jaynes-Cummings Hamiltonian with Hilbert space dimension of 10.
 
 Examples
 --------
@@ -101,7 +100,7 @@ Examples
    * - Wigner distribution depicting the evolution of mechanical squeezing in a modulated optomechanical system.
      - Soliton propagation in an array of optomechanical systems at different phase lags between the input solitons.
 
-A set of notebooks and scripts to demonstrate the usage of the toolbox can be found `here <https://github.com/sampreet/qom-examples>`_.
+A set of notebooks and scripts to demonstrate the usage of the toolbox can be found in the `examples repository <https://github.com/sampreet/qom-examples>`_.
 
 Installation
 ============
@@ -126,7 +125,9 @@ These libraries can be installed using:
 
 .. note:: To run the GUI modules, ``pyqt`` should be installed separately.
 
-Once the dependencies are installed, the toolbox can be installed via PyPI (last release: v0.9.0) or locally (latest version: v1.0.0).
+Once the dependencies are installed, the toolbox can be installed via PyPI or locally.
+
+The documentation of the latest release is available `here <https://sampreet.github.io/qom-docs>`_.
 
 Installing via PyPI
 -------------------
@@ -137,20 +138,16 @@ To install the packages via the Python Package Index (PyPI), execute:
 
    pip install -i https://test.pypi.org/simple/ qom
 
-The corresponding documentation is available `here <https://sampreet.github.io/qom-docs/v0.9.0>`_.
-
 Installing Locally
 ------------------
 
 To install the package locally, download `the repository <https://github.com/sampreet/qom>`_ as ``.zip`` and extract the contents.
-Now, execute the following from *outside* the top-level directory, ``ROOT_DIR``, inside which ``setup.py`` is located (refer to the file structure `here <https://github.com/sampreet/qom/blob/master/CONTRIBUTING.md>`_):
+Now, execute the following from *outside* the top-level directory, ``ROOT_DIR``, inside which ``setup.py`` is located (refer to the `file structure <https://github.com/sampreet/qom/blob/master/CONTRIBUTING.md>`_):
 
 .. code-block:: bash
 
    pip install -e ROOT_DIR
 
-The corresponding documentation is available `here <https://sampreet.github.io/qom-docs>`_.
-
 Citing
 ======
 

docs/source/index.rst

@@ -9,4 +9,5 @@ qom.solvers package
    qom.solvers.deterministic
    qom.solvers.differential
    qom.solvers.measure
-   qom.solvers.stability
+   qom.solvers.stability
+   qom.solvers.stochastic

docs/source/qom.solvers.rst

@@ -0,0 +1,8 @@
+qom.solvers.stochastic module
+=============================
+
+.. automodule:: qom.solvers.stochastic
+   :members:
+   :private-members:
+   :undoc-members:
+   :show-inheritance:

docs/source/qom.solvers.stochastic.rst

@@ -6,9 +6,10 @@
 __name__ = 'qom.io'
 __authors__ = ["Sampreet Kalita"]
 __created__ = "2023-05-28"
-__updated__ = "2023-07-12"
+__updated__ = "2023-08-14"
 
 # dependencies
+import logging
 import numpy as np
 import os
 import time
@@ -20,8 +21,8 @@ class Updater():
 
     Parameters
     ----------
-    logger : :class:`logging.logger`
-        Module logger.
+    name : str
+        Name of the module or class.
     cb_update : callable, optional
         Callback function to update status and progress, formatted as ``cb_update(status, progress, reset)``, where ``status`` is a string, ``progress`` is a float and ``reset`` is a boolean.
     parallel : bool, default=False
@@ -32,11 +33,11 @@ class Updater():
         Time at which the process was started. If not provided, the value is initialized to current time.
     """
 
-    def __init__(self, logger, cb_update, parallel:bool=False, p_index:int=0, p_start:float=None):
+    def __init__(self, name, cb_update, parallel:bool=False, p_index:int=0, p_start:float=None):
         """Class constructor for Updater."""
 
         # set constants
-        self.logger = logger
+        self.logger = logging.getLogger(name)
         self.cb_update = cb_update
         self.parallel = parallel
         self.p_index = p_index
@@ -99,7 +100,7 @@ def update_progress(self, pos:int, dim:int, status:str, reset:bool):
         status = status if status is not None else ""
 
         # current time
-        _time = time.time() 
+        _time = time.time()
 
         # display progress
         _init_or_comp = reset or progress == 100.0

qom/io.py

@@ -6,13 +6,12 @@
 __name__ = 'qom.loopers.base'
 __authors__ = ["Sampreet Kalita"]
 __created__ = "2020-12-21"
-__updated__ = "2023-07-12"
+__updated__ = "2023-10-04"
 
 # dependencies
 from decimal import Decimal
 from typing import Union
 import copy
-import logging
 import numpy as np
 import time
 
@@ -95,8 +94,6 @@ def __init__(self, func, params:dict, params_system:dict, cb_update, parallel:bo
         self.func = func
         self.parallel = parallel
         self.p_index = p_index
-        self.time = time.time()
-        self.p_start = p_start if p_start is not None else self.time
 
         # set parameters
         self.set_params(params)
@@ -118,11 +115,11 @@ def __init__(self, func, params:dict, params_system:dict, cb_update, parallel:bo
 
         # set updater
         self.updater = Updater(
-            logger=logging.getLogger('qom.loopers.' + self.name),
+            name='qom.loopers.' + self.name,
             cb_update=cb_update,
             parallel=parallel,
             p_index=p_index,
-            p_start=self.p_start
+            p_start=p_start if p_start is not None else time.time()
         )
         # display initialization
         self.updater.update_info(
@@ -168,7 +165,10 @@ def set_axis(self, axis:str):
         _val = _axis.get('val', None)
         # convert to numpy array
         if type(_val) is list:
-            _val = np.array(_val, dtype=np.float_)
+            if type(_val[0]) is int:
+                _val = np.array(_val, dtype=np.int32)
+            elif type(_val[0]) is float:
+                _val = np.array(_val, dtype=np.float_)
         # update values
         if type(_val) is np.ndarray:
             # validate values