Grover's Algorithm

⭐️⭐️⭐️ Please star this repo if you find it helpful, interesting, or useful! ⭐️⭐️⭐️

Requirements

Anaconda OR Miniconda

Tip

If you have trouble deciding between Anaconda and Miniconda, please refer to the table below

Anaconda	Miniconda
New to conda and/or Python	Familiar with conda and/or Python
Not familiar with using terminal and prefer GUI	Comfortable using terminal
Like the convenience of having Python and 1,500+ scientific packages automatically installed at once	Want fast access to Python and the conda commands and plan to sort out the other programs later
Have the time and space (a few minutes and 3 GB)	Don't have the time or space to install 1,500+ packages
Don't want to individually install each package	Don't mind individually installing each package

Typing out entire Conda commands can sometimes be tedious, so I wrote a shell script (conda_shortcuts.sh on GitHub Gist) to define shortcuts for commonly used Conda commands.

Example: Delete/remove a conda environment named test_env

Shortcut command
```
rmenv test_env
```

Manually typing out the entire command

conda env remove -n test_env && rm -rf $(conda info --base)/envs/test_env

The shortcut has 80.8% fewer characters!

Installation

Verify that conda is installed
```
conda --version
```
Ensure conda is up to date
```
conda update conda
```
Enter the directory where you want the repository (grovers-algorithm) to be cloned
- POSIX
```
cd ~/path/to/directory
```
- Windows
```
cd C:\Users\user\path\to\directory
```

Clone the repository (grovers-algorithm), then enter its directory

git clone https://github.com/lynkos/grovers-algorithm.git && cd grovers-algorithm

Create a conda virtual environment from environment.yml
```
conda env create -f environment.yml
```
Activate the virtual environment (grovers_env)
```
conda activate grovers_env
```
Confirm that the virtual environment (grovers_env) is active
- If active, the virtual environment's name should be in parentheses () or brackets [] before your command prompt, e.g.
```
(grovers_env) $
```
- If necessary, see which environments are available and/or currently active (active environment denoted with asterisk (*))
```
conda info --envs
```
  OR
```
conda env list
```

Usage

Python Script

Command Line (Recommended)

Run grovers_algorithm.py

POSIX
```
python grovers_algorithm.py
```
Windows
```
python grovers_algorithm.py
```

Command Line Arguments

Option	Type	Description	Default
`-H, --help`		Show help message and exit
`-T, --title <title>`	`str`	Window title	"Grover's Algorithm"
`-n, --n-qubits <n_qubits>`	`int`	Number of qubits	`5`
`-s, --search <search>`	`int`	Nonnegative integers to search for	`11 9 0 3` (i.e., { 11, 9, 0, 3 })
`-S, --shots <shots>`	`int`	Number of simulations	`1000`
`-f, --font-size <font_size>`	`int`	Histogram's font size	`10`
`-p, --print`	`bool`	Whether or not to print quantum circuit(s)	`False`
`-c, --combine`	`bool`	Whether to combine all non-winning states into 1 bar labeled "Others" or not	`False`

Deactivate the virtual environment (grovers_env) when you're finished
```
conda deactivate
```

Visual Studio Code

Open grovers_algorithm.py
Run grovers_algorithm.py: Click ▷ (i.e. Play button) in the upper-right corner
Deactivate the virtual environment (grovers_env) when you're finished
```
conda deactivate
```

Jupyter Notebook

Visual Studio Code (Recommended)

Open the Command Palette with the relevant keyboard shortcut
- Mac
```
⌘ + Shift + P
```
- Windows
```
CTRL + Shift + P
```
Search and select Python: Select Interpreter
Select the virtual environment (grovers_env)
Open grovers_algorithm.ipynb
Confirm grovers_env is the selected kernel
Run grovers_algorithm.ipynb by clicking Run All
Deactivate the virtual environment (grovers_env) when you're finished
```
conda deactivate
```

Command Line

Install ipykernel in the virtual environment (grovers_env)
```
conda install -n grovers_env ipykernel
```
Add the virtual environment (grovers_env) as a Jupyter kernel
```
python -m ipykernel install --user --name=grovers_env
```
Open grovers_algorithm.ipynb in the currently running notebook server, starting one if necessary
```
jupyter notebook grovers_algorithm.ipynb
```
Select the virtual environment (grovers_env) as the kernel before running grovers_algorithm.ipynb
Deactivate the virtual environment (grovers_env) when you're finished
```
conda deactivate
```

Name		Name	Last commit message	Last commit date
Latest commit History 228 Commits
LICENSE.md		LICENSE.md
README.md		README.md
environment.yml		environment.yml
grovers_algorithm.ipynb		grovers_algorithm.ipynb
grovers_algorithm.py		grovers_algorithm.py

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

LICENSE.md

LICENSE.md

README.md

README.md

environment.yml

environment.yml