A Fresh Installation on Windows

[xumingkuan]

This issue is to track the steps of a fresh installation on my Windows laptop on Feb 13, 2023.

Prerequisites

• I have cmake version 3.21.0-rc3.
• I have Microsoft Visual Studio Community 2019 Version 16.11.5.

• I installed Anaconda3 version 2022.10 with Python 3.9.

  • I added the channel conda-forge to Anaconda3: conda config --add channels conda-forge. When typing conda config --show channels, the output is

    channels:
    - conda-forge
    - defaults

    This is necessary for finding some of the required packages.

  • I copied the files specified in https://github.com/conda/conda/issues/8273. Without doing this, I get the following error:

    
    Collecting package metadata (repodata.json): failed

  CondaSSLError: OpenSSL appears to be unavailable on this machine. OpenSSL is required to download and install packages.

  Exception: HTTPSConnectionPool(host='repo.anaconda.com', port=443): Max retries exceeded with url: /pkgs/main/win-64/repodata.json (Caused by SSLError("Can't connect to HTTPS URL because the SSL module is not available."))

  
  - I *deleted* the `PYTHONHOME` and `PYTHONPATH` environment variables. This is necessary for the command `conda env create --name quartz --file env.yml` to create the environment properly.
  - If there is a previous Conda environment named `quartz`, we should remove it by running `conda env remove --name quartz`.

Build Quartz Runtime

git clone --recursive https://github.com/quantum-compiler/quartz.git
cd quartz
conda env create --name quartz --file env.yml
conda activate quartz
pip3 install -r python/requirements.txt
mkdir build
cd build
cmake ..

Use Visual Studio 2019 to open quartz/build/Quartz.sln, click Build -> Build Solution (F7). Then return to the command line:

:: Should be at the build/ directory of Quartz now
"Debug/test_all.exe"

Optional: CLion Integration

Additional prerequisites:

• I have CLion 2022.2.1.

CLion settings:

• Settings -> Build, Execution, Deployment -> Toolchains -> add "Visual Studio"
  • Toolset: select the folder where Visual Studio 2019 is installed.
  • Architecture: select amd64.
  • Add environment -> From file -> Environment file: (path\to\quartz)\scripts\setup_environment.bat
• Settings -> Build, Execution, Deployment -> CMake -> add "Debug"
• Settings -> Build, Execution, Deployment -> Python Interpreter -> select Python 3.10 (quartz) (the version may vary)
• Settings -> Editor -> Code Style -> Enable ClangFormat
• Settings -> Plugins -> "BlackConnect" -> Install