Package: opensquirrel
Mini-compiler for Quantum Inspire's quantum chip(munk)s,;;:;,
   ;;;;;
  ,:;;:;    ,'=.
  ;:;:;' .=" ,'_\
  ':;:;,/  ,__:=@
   ';;:;  =./)_
 jgs `"=\_  )_"`
          ``'"`Installation$pipinstallopensquirrelEditable installationTo perform an editable install, run the following command in the root directory ofOpenSquirrelwith the-eflag:$pipinstall-e.To install the developer specific dependencies, run the command:$pipinstall-e'.[dev]'DocumentationOpenSquirrel documentation is hosted through GitHub Pageshere.MkDocsThe documentation is generated using MkDocs. For full documentation visitmkdocs.org.mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.In order to buildOpenSquirreldocumentation, run the following command in the root directory ofOpenSquirrel:mkdocsbuildStyle guideWe use theGoogle style guidefor the docstring format.ToolsPoetryProject dependencies are specified in thepyproject.tomlfile in the root directory of the project.Website:https://python-poetry.org/Install dependencies:$poetryinstallStart a Poetry shell:$poetryshellWithin the shell PyTest and MyPy can be run accordingly:$mypy-popensquirrel$pytestDev ContainerPyCharmOpen the Dev Container configuration file located at.devcontainer/devcontainer.jsonin the PyCharm editor.On the left of the editor, in the gutter, you should see the Docker icon:or.Upon clicking on the Docker icon, the following options appear (depending on the PyCharm version used):Create Dev Container and Mount Sources..., andShow 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...If you selectCreate 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 thedevcontainer/Dockerfile.The system dependencies are installed, a user account (i.e.pydev) is created,
and additional Python packages and Poetry are installed.Upon completion the status messages should read something like:'Dev Container' has been deployed successfullyandEnvironment is successfully prepared…Proceed by choosing your PyCharm installation, from the dropdown menu that appears at the top,
and clickContinue.A connection is established with the remote host and a new PyCharm window is opened.Skip the following subsection and proceed below.Show Dev ContainersIf you selectShow 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:dockerps-aIf 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:dockercontainerstart<container-name>A running Dev Container can be accessed from the terminal, accordingly:dockerexec-it<container-name>bashThe-iflag stands for interactive session and the-tstands for running it in the terminal.Once you have accessed the Dev Container, change to the userpydev:sudo-upydev-iAnd make sure to navigate to the project root folder:cd/IdeaProjects/OpenSquirrel/Continue to install the dependencies (if not done already in this container; otherwise you may skip this step):poetryinstalland initiating the Poetry shell environment:poetryshell