Implement CI/CD improvements

Author: dieriver

.github/workflows/docs.yaml

@@ -40,6 +40,9 @@ jobs:
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
+    permissions:
+      pages: write
+      id-token: write
     steps:
       - name: Deploy to GitHub Pages
         id: deployment

CHANGELOG.md

@@ -3,9 +3,16 @@ CHANGELOG
 
 For more details refer to the [documentation](https://softwarequtech.github.io/SimulaQron/html/index.html).
 
-Upcoming
---------
-2026-03-13 (v4.0.1)
+
+2026-04-23 (v4.1.1)
+-------------------
+- Update README file.
+- Added `install-development` target in the Makefile to ease the process of installing development dependencies.
+- Remove old "nativeMode" files after rename of the folder.
+- Adjusted Dockerfile to use the lates PyPI deployed version of SimulaQron.
+- Fixed GitHub workflow to automatically deploy documentation.
+
+2026-04-16 (v4.1)
 -------------------
 - Migrated project specification to use modern TOML approach.
 - Tested working with Python versions 3.10, 3.11 and 3.12.
@@ -19,7 +26,7 @@ Upcoming
 -------------------
 - Major breaking change! Using `cqc` is now deprecated and replaced with `netqasm`.
   `netqasm` improves on `cqc` on many levels, for more details.
-  As with `cqc`, `netqasm` also has a SDK in python for writing applications, which is very similar to the SDK for `cqc`.
+  As with `cqc`, `netqasm` also has an SDK in python for writing applications, which is very similar to the SDK for `cqc`.
   However, there are some differences, for details see [the netqasm repo](https://github.com/QuTech-Delft/netqasm) and [its documentation](https://netqasm.readthedocs.io/en/latest/).
 
 2020-08-24 (v3.0.16)

Dockerfile

@@ -52,19 +52,25 @@ RUN python3.12 -m venv simulaqron-venv
 ENV PATH="${UHOME}/simulaqron-venv/bin:$PATH"
 
 # Install SimulaQron
-# Option 1: Install from the wheel file
+# Option 1: Install from PyPI
+RUN pip install "simulaqron[opt]"
+
+# Option 2: Install from the wheel file - for testing purposes
+# Using this option requires that you build SimulaQron locally before you build the docker image.
+# Before building the docker image, make sure you have installed simulaqron "development" dependencies:
+# `make install-development`.
+# Then, you can build SimulaQron using the makefile: `make build`.
+
 # Copy the simulaqron wheel into the container
-COPY dist/*.whl ${UHOME}
-RUN pip install *.whl
-RUN rm *.whl
+#COPY dist/*.whl ${UHOME}
+#RUN pip install *.whl
+#RUN rm *.whl
 
-# Install extra packages that need build-essential
-RUN pip install "qutip<5.0.0"
-RUN pip install "setuptools<81" pybind11
-RUN pip install "git+https://github.com/ProjectQ-Framework/ProjectQ.git@v0.8.0" --no-build-isolation
+## Install extra packages that need build-essential
+#RUN pip install "qutip<5.0.0"
+#RUN pip install "setuptools<81" pybind11
+#RUN pip install "git+https://github.com/ProjectQ-Framework/ProjectQ.git@v0.8.0" --no-build-isolation
 
-# Option 2: (Recommended for release) Install from PyPI
-#RUN pip install "simulaqron[opt]>=4.0.1"
 
 FROM base-image AS run-image
 

Makefile

@@ -24,6 +24,11 @@ test-deps:
 requirements python-deps:
 	@${PYTHON} -m pip install .
 
+dev-deps:
+	@${PYTHON} -m pip install .\[dev\]
+
+install-development: dev-deps
+
 install-optional: install
 	# Python setuptools 81 removed "dry_run" option when compiling C++ code
 	# this breaks the build of projectq
@@ -79,7 +84,7 @@ _remove_egg_info:
 _clear_build: _remove_build _remove_dist _remove_egg_info
 
 _build:
-	@${PYTHON} setup.py sdist bdist_wheel
+	@${PYTHON} -m build --sdist --wheel --outdir dist/ .
 
 build: _clear_build _build
 

README.md

@@ -1,4 +1,4 @@
-# SimulaQron - simple quantum network simulator (4.0.0)
+# SimulaQron - simple quantum network simulator (4.1.1)
 
 The purpose of this simulator of quantum network nodes is to allow you to develop new applications for
 a future quantum internet, while we do not yet have real quantum network nodes available for testing. 
@@ -23,7 +23,7 @@ Then you can install Python 3.12 and the Python development package:
 sudo apt-get install python3.12-full python3.12-dev
 ```
 
-Additionally, you will need the `build-essential` package, to install tools used when building some SimulaQron dependencies::
+Additionally, you will need the `build-essential` package, to install tools used when building some SimulaQron dependencies:
 
 ```shell
 sudo apt-get install build-essential cmake vim linux-headers-generic
@@ -40,6 +40,12 @@ Additionally, you can install SimulaQron with extra dependencies:
 make install-optional
 ```
 
+
+Finally, if you would like to contribute to the development of SimulaQron, please install the development dependencies:
+```shell
+make install-development
+```
+
 ### Windows
 
 In Windows, SimulaQron can be installed in two similar ways:

examples/nativeMode/corrRNG/classicalNet.json

@@ -32,7 +32,6 @@ description = "A simulator for developing Quantum Internet software"
 readme = "README.md"
 keywords = ["egg", "bacon", "sausage", "tomatoes", "Lobster Thermidor"]
 classifiers = [
-        "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: 3.11",
         "Programming Language :: Python :: 3.12",