Version 0.6.3

Version 0.6.3 is released!

Added

• We have an Icon for SeQUeNCe!
• pip install sequence is now available!
• src folder is renamed to sequence
• Add sequence/constants.py to organize the common constants
• Add support for Python 3.12
• Add pyproject.toml

Changed

• Various refactoring, include but not limited to updating variable/method names, moving/deleting code, adding/rewriting comments, and making the code more succinct, etc.
• In README.md, installation with option --editable is encouraged.
• logging looks better
• In class Reservation, added attribute entanglement_number and id
• Update ResourceReservationProtocol.load_rules()
• Move utils/json_config_generators/generator_utils.py to sequence/utils/config_generator.py

Removed

• Removed support for Python 3.8
• Removed setup.py
• Removed MANIFEST.in

IEEE QCE 2023

This release fixes a couple bugs in the GUI and contains the simulation scripts used for the IEEE QCE 2023 conference in Bellevue, Washington. Some further details can be found in CHANGELOG.md.

Memory Simulation

This update involves a lot of additions to the kernel, namely Fock state density matrix formalism. We've also added a few hardware models on top of this. You can read about these models in a recent paper here. And as always, there are further details listed in the changelog.

Refactoring

This is a small release that includes some minor code adjustments. The most noteworthy is that the entangle method of photons and states was changed to combine_state; this is to better illustrate what is actually happening in the code (no entanglement but simply combining state objects. There were also a few bug fixes, mainly with regards to the state manager. As per usual a full list of changes may be found in CHANGELOG.md.

Bug Fixes

This minor release fixes a bug with the global parameters defined using the SeQUeNCe GUI.

GUI Fixes

This update fixes some bugs for classical delay in the SeQUeNCe GUI. Additionally, we have added some further example scripts for the QCE 2022 conference and removed mpi4py from the installation instructions.

Parallel Separation

This update moves all parallel simulation code to the parallel directory; to utilize parallel execution, users should install the psequence package using the setup.py file within the parallel folder (in addition to the C++ server code, if desired). This is to simplify installation of the main sequence package, which no longer has an mpi4py dependency (and thus no need for an MPI installation on the host machine). Additionally, some of the existing parallel scripts are in the process of being rewritten; users should look to the documentation website for information on usage.

Additionally, more scripts have been added to the QCE_demos folder. Expect more additions and changes through version 0.5.2, which will be released in the next couple days.

Hardware API Standardization

This release overhauls the API for the hardware module. This includes the _receivers attribute for all Entities, which is a list of entities that may receive photons via the get interface. The photon class has also been redone to allow for both quantum manager usage (in the case of memories, where quantum states need extended storage and functionality) and direct usage of quantum states, as before (i.e. for BB84). The GUI continues to be developed.

Additionally, this update adds some preliminary scripts to be used for the SeQUeNCe tutorial at IEEE Quantum Week 2022. These will continue to be updated over the next week.

GUI

This release integrates the SeQUeNCe GUI, developed by @alexk101 since summer 2021. The source code may be viewed in the sequence.gui module, while the GUI may be launched by running the gui.py script in the root director of the repository. The GUI is currently fully capable of viewing and generating network setups, but is not yet able to run simulations natively. We will continue to develop the GUI and appreciate any feedback as to its use.

Additionally, this version updates some package requirements, which means that the minimum required Python version for the simulator is now 3.8. The simulator has been tested and is working for versions 3.8, 3.9, and 3.10.

As always, a complete list of changes may be viewed in CHANGELOG.md.

Documentation Fixes

This is a small bug fix update that addresses some issues with the outward-facing example code and documentation. Specifically, the units for some example scripts were fixed and bugs were fixed for some tutorial scripts.