Merge pull request #151 from sequence-toolbox/RnD

QCE conference final touches

.github/workflows/main.yml

@@ -2,9 +2,9 @@ name: main
 
 on:
   push:
-    branches: [master, RnD, remove_mpi]
+    branches: [master, RnD]
   pull_request:
-    branches: [master. RnD, remove_mpi]
+    branches: [master. RnD]
 
 jobs:
   build:

CHANGELOG.md

@@ -119,3 +119,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 - Removed `mpi4py` and `pytest-mpi` requirements for main package
+
+## [0.5.2]
+### Added
+- Added more scripts for the QCE 2022 conference
+
+### Changed
+- Fixed some bugs in the GUI code for classical communication delay
+
+### Removed
+- Removed `mpi4py` from install instructions on the README

README.md

@@ -11,9 +11,6 @@ These modules can be edited by users to define additional functionality and test
 
 ## Installing
 SeQUeNCe requires an installation of Python 3.8 or later. This can be found at the [Python Website](https://www.python.org/downloads/).
-The `mpi4py` package additionally requires an MPI installation on the local machine.
-For a few options listed by the MPI for python package, please see [this documentation page](https://mpi4py.readthedocs.io/en/stable/appendix.html#building-mpi).
-
 Then, simply download the package, navigate to its directory, and install with
 ```
 $ pip install .

docs/source/conf.py

@@ -22,7 +22,7 @@
 author = 'Xiaoliang Wu, Joaquin Chung, Alexander Kolar, Eugene Wang, Tian Zhong, Rajkumar Kettimuthu, Martin Suchara'
 
 # The full version, including alpha/beta/rc tags
-release = '0.5.1'
+release = '0.5.2'
 
 
 # -- General configuration ---------------------------------------------------

docs/source/parallel/install/prerequisite.md

@@ -3,7 +3,8 @@
 This set of three pages will go through the setup and usage of SeQUeNCe's parallel simulation capabilities. In this first page, we will review how to install the necessary requirements for parallel simulation.
 
 ## Additional Required Installations
-To run the parallel simulations fully in Python, only the MPI for Python library must be installed. The rest of the parallel simulation will work with installation of the SeQUeNCe library.
+To run the parallel simulations fully in Python, the MPI for Python library must be installed.
+The rest of the parallel simulation will then work with installation of the parallel SeQUeNCe library `psequence`.
 
 ### MPI for Python
 Before installing MPI for Python, an implementation of MPI must be installed on your system. Most working MPI implementations can be used, preferably those supporting MPI-3 and built with shared/dynamic libraries. For a few options listed by the MPI for python package, please see [this documentation page](https://mpi4py.readthedocs.io/en/stable/appendix.html#building-mpi).
@@ -13,6 +14,17 @@ After this has been completed, the Python library may be installed as
 $ pip install mpi4py
 ```
 
+### Parallel SeQUeNCe
+After this, the parallel `psequence` package may be installed.
+This is handled in a similar manner to the base package; simply navigate to the parallel folder and run
+```
+$ pip install .
+```
+Or, using the included makefile,
+```
+$ make install
+```
+
 ## C++ Quantum Manager Server
 In addition to the Quantum Manager Server written in Python, SeQUeNCe also provides a version of the server written in C++. This version also provides multithreading to support the processing of multiple Quantum Manager Client requests, and generally results in performance increases (see our paper TODO: add link). To run this version, a few additional steps must be taken:
 * Installing CMake, a tool for managing and compiling the Quantum Manager Server code,