Skip to content

Latest commit

 

History

History
45 lines (35 loc) · 1.71 KB

INSTALL.md

File metadata and controls

45 lines (35 loc) · 1.71 KB
Raw

Installation of LintQ

Table of Contents:

  • Step-by-step instructions for installing LintQ
  • Installation Check

Step-by-step instructions for installing LintQ

  1. Clone the repository: 
    git clone <this-repo-github-url>
  2. Open the REQUIREMENTS.md file and check that your hardware setup satisfies the recommended requirements. Check also that your system has conda and docker installed. If not, follow the installation guide there to obtain the software you need. We recommend using an environment that is as close as possible to those we used for our experiments, refer to the REQUIREMENTS.md file.
  3. install the Python dependencies via Conda virtual environment from our configuration file here: 
    conda env create -f virtualenv/conda/environment.yml
  4. activate the virtual environment: 
    conda activate LintQEnv
  5. Build the docker image to run LintQ, run this command from the root of the repo: 
    python automation_scripts/create_docker_image_locally.py
    At the end check that the docker image has been build correctly by running: docker images, you should see an image named lintq.

Installation Check

  1. To check that you set up LintQ correctly run this command: 
    docker run -v "$(pwd)/data:/home/codeql/project/data" -it --rm lintq codeql pack ls /usr/local/codeql-home/
    That should show you the following: 
    Running on packs: mattepalte/qlint-tests, mattepalte/qiskit, mattepalte/qlint.
Found mattepalte/qiskit@0.0.1
Found mattepalte/qlint@0.0.1
Found mattepalte/qlint-tests@0.0.0