Merge branch 'develop' into some-small-changes-to-readme

Author: elenbaasc

.devcontainer/Dockerfile

@@ -10,7 +10,7 @@ RUN apt-get update -y && \
     apt-get clean
 
 # Set up user
-ARG USER=vscode
+ARG USER=pydev
 ENV PATH /home/${USER}/.local/bin:$PATH
 RUN groupadd -r ${USER} && \
     useradd -m -r -s /bin/bash -g ${USER} ${USER} && \

.devcontainer/devcontainer.json

@@ -3,8 +3,8 @@
 	"build": {
 		"dockerfile": "Dockerfile",
 		"args": {
-			"USER": "vscode"
+			"USER": "pydev"
 		}
 	},
-	"remoteUser": "vscode"
+	"remoteUser": "pydev"
 }

README.md

@@ -83,3 +83,84 @@ $ mypy -p opensquirrel
 ```shell
 $ pytest
 ```
+
+## Dev Container
+
+### PyCharm
+
+Open the Dev Container configuration file located at `.devcontainer/devcontainer.json` in the PyCharm editor.
+
+On the left of the editor, in the gutter, you should see the Docker icon:
+<img src="docs/_static/devcontainer_docker_icon.png" width="20" height="20"> or
+<img src="docs/_static/devcontainer_docker_icon_2.png" width="20" height="20">.
+
+Upon clicking on the Docker icon, the following options appear (depending on the PyCharm version used):
+- **Create Dev Container and Mount Sources...**, and
+- **Show Dev Containers**.
+
+If no Dev Containers have been created previously,
+select the former option and proceed to create a Dev Container,
+otherwise select the latter option to list the existing Dev Containers.
+
+#### Create Dev Container and Mount Sources...
+
+1. If you select **Create Dev Container and Mount Sources...**,
+  a separate window (*Building Dev Container*) will open and
+  a Dev Container will be built according to the specification in the `devcontainer/Dockerfile`.
+2. The system dependencies are installed, a user account (*i.e.* **pydev**) is created,
+  and additional Python packages and Poetry are installed.
+3. Upon completion the status messages should read something like:
+  *'Dev Container' has been deployed successfully* and *Environment is successfully prepared…*
+4. Proceed by choosing your PyCharm installation, from the dropdown menu that appears at the top,
+  and click **Continue**.
+5. A connection is established with the remote host and a new PyCharm window is opened.
+6. Skip the following subsection and proceed below.
+
+#### Show Dev Containers
+
+1. If you select **Show Dev Containers**,
+  a separate window appears where the existing (previously created) Dev Containers are listed by their name and status
+  (*i.e.* either running or idle). In general, all docker containers (including idle ones) can be listed using:
+
+   ```bash
+   docker ps -a
+   ```
+
+2. If they are idle they can be started by clicking on their name or on the play button.
+  An idle (Dev) Container can also be started from the terminal:
+
+   ```bash
+   docker container start <container-name>
+   ```
+
+  A running Dev Container can be accessed from the terminal, accordingly:
+
+  ```bash
+  docker exec -it <container-name> bash
+  ```
+
+  The `-i` flag stands for interactive session and the `-t` stands for running it in the terminal.
+
+Once you have accessed the Dev Container, change to the user **pydev**:
+
+```bash
+sudo -u pydev -i
+```
+
+And make sure to navigate to the project root folder:
+
+```bash
+cd /IdeaProjects/OpenSquirrel/
+```
+
+Continue to install the dependencies (if not done already in this container; otherwise you may skip this step):
+
+```bash
+poetry install
+```
+
+and initiating the Poetry shell environment:
+
+```bash
+poetry shell
+```

docs/_static/devcontainer_docker_icon.PNG

@@ -60,9 +60,11 @@ def _get_expanded_squirrel_args(cls, generator_f, cqasm_args):
         )
 
         expanded_args = [
-            cls._get_qubits(cqasm_arg)
-            if expected_parameter.annotation == Qubit
-            else [cls._get_literal(cqasm_arg)] * number_of_operands
+            (
+                cls._get_qubits(cqasm_arg)
+                if expected_parameter.annotation == Qubit
+                else [cls._get_literal(cqasm_arg)] * number_of_operands
+            )
             for cqasm_arg, expected_parameter in zip(cqasm_args, parameters)
         ]
 

docs/_static/devcontainer_docker_icon_2.PNG

@@ -44,10 +44,10 @@ mkdocs-material = "^9.4.12"
 libqasm = "0.5.2"
 
 [tool.poetry.group.dev.dependencies]
-black = "^23.11.0"
+black = ">=23.11,<25.0"
 coverage = {extras = ["toml"], version = "^7.3.2"}
 isort = "^5.11.4"
-pytest = {extras = ["toml"], version = "^7.4.3"}
+pytest = {extras = ["toml"], version = ">=7.4.3,<9.0.0"}
 pytest-cov = "^4.1.0"
 mypy = "^1.7.0"