Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

requirements.txt + installation guide added. #55

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 58 additions & 0 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
While the fall 2022 challenge is over, you can still run the Jupyter notebooks using one of these two options:

Option 1: Run the Jupyter notebooks in the IBM Quantum Lab:
===========================================================

1. Create an IBM quantum account on https://quantum-computing.ibm.com/ .
2. Go to the IBM quantum dashboard.
3. Click "Launch Lab".
4. Upload the [jupyter notebooks](content) from the github repository.
5. Open _lab1.ipynb_.
6. Insert a new cell at the top of the notebook and run this in it:
```
!pip install git+https://github.com/qiskit-community/Quantum-Challenge-Grader.git
```
7. Insert a new cell after the previous one and run this in it:
```
%env QC_GRADE_ONLY=true
```
8. Now you are ready to solve all exercises.

Option 2: Run the Jupyter notebooks on your local computer using Anaconda:
==========================================================================

**Note: You will still need to create an account on https://quantum-computing.ibm.com/ to run some of the cells that use IBM backends.**

1. Install Anaconda:

https://www.anaconda.com/

2. Open an Anaconda prompt.

3. Create a new environment and activate it:
```
conda create --name ibm-quantum-challenge-fall-22 python=3.8.12
conda activate ibm-quantum-challenge-fall-22
```

4. Change into the directory containing [requirements.txt](requirements.txt):
```
cd "ibm-quantum-challenge-fall-22"
```

5. Install requirements:
```
pip install -r requirements.txt
```

6. Start Jupyter:
```
jupyter notebook
```

7. Since the fall challenge is over, make sure you run the following in a new cell in the notebooks before running any other cells in order to be able to run the grader:
```
%env QC_GRADE_ONLY=true
```

If you had already run some cells, restart the kernel after running that command.
20 changes: 20 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
notebook
numpy
matplotlib
qiskit==0.39.2
qiskit-aer==0.11.1
qiskit-experiments==0.4.0
qiskit-finance==0.3.4
qiskit-ibm-experiment==0.2.8
qiskit-ibm-provider==0.1.0
qiskit-ibm-runtime==0.8.0
qiskit-ibmq-provider==0.19.2
qiskit-machine-learning==0.5.0
qiskit-nature==0.5.0
qiskit-optimization==0.4.0
qiskit-terra==0.22.2
prototype-zne==1.0.0
pylatexenc
typeguard
pathlib
qc-grader @ git+https://github.com/qiskit-community/Quantum-Challenge-Grader.git