⭐️⭐️⭐️ Please star this repo if you find it helpful, interesting, or useful! ⭐️⭐️⭐️
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 |
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 |
- 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
- POSIX
- Clone the repository (
grovers-algorithm
), then enter its directorygit 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 (*))
OR
conda info --envs
conda env list
- If active, the virtual environment's name should be in parentheses () or brackets [] before your command prompt, e.g.
Visual Studio Code (Recommended)
- Open the Command Palette in Visual Studio Code with the relevant keyboard shortcut
- Mac
⌘ + Shift + P
- Windows
CTRL + Shift + P
- Mac
- Search and select
Python: Select Interpreter
- Select the virtual environment (
grovers_env
) - Open
Grovers-Algorithm.ipynb
and/orGrovers-Algorithm.py
- Confirm
grovers_env
is the selected kernel - Run program(s)
Grovers-Algorithm.ipynb
: ClickRun All
Grovers-Algorithm.py
: Click▷
(i.e.Play
button) in the upper-right corner
- Deactivate the virtual environment (
grovers_env
) when you're finishedconda deactivate
- Run
Grovers-Algorithm.py
- POSIX
$(which python) Grovers-Algorithm.py
- Windows
$(where python) Grovers-Algorithm.py
- POSIX
- Deactivate the virtual environment (
grovers_env
) when you're finishedconda deactivate
- Install
ipykernel
in the virtual environment (grovers_env
)conda install -n grovers_env ipykernel
- Add the virtual environment (
grovers_env
) as a Jupyter kernelpython -m ipykernel install --user --name=grovers_env
- Open
Grovers-Algorithm.ipynb
in the currently running notebook server, starting one if necessaryjupyter notebook Grovers-Algorithm.ipynb
- Select the virtual environment (
grovers_env
) as the kernel before runningGrovers-Algorithm.ipynb
- Deactivate the virtual environment (
grovers_env
) when you're finishedconda deactivate
Tip
Instead of manually typing out entire conda commands, you can save time with shortcuts.
Add conda_shortcuts.sh
then source shell startup file (e.g., .bashrc
) or restart terminal to apply changes.
- POSIX
cat conda_shortcuts.sh >> ~/.bashrc source ~/.bashrc
- Windows
type conda_shortcuts.sh >> C:\Users\user\path\to\.bashrc source C:\Users\user\path\to\.bashrc
Command | Description | Usage |
---|---|---|
act |
Activate conda environment | act [env_name] |
dac |
Deactivate conda environment | dac |
mkenv |
Create conda environment(s) | mkenv [yaml_file1] [yaml_file2] ... [yaml_fileN] |
mkenv [env_name] [package1] [package2] ... [packageN] |
||
rmenv |
Remove conda environment(s) | rmenv [env1] [env2] ... [envN] |
rnenv |
Rename conda environment | rnenv [curr_name] [new_name] |
cpenv |
Copy conda environment | cpenv [env_name] [copy's_name] |
exp |
Export conda environment | exp [out_file] |
lsenv |
List conda environment | lsenv |
Warning
Conda shortcut commands have ONLY been tested on bash v5.2.26(1)-release
with aarch64-apple-darwin23.2.0
architecture, so — just to be safe — test and make changes as needed.
E.g., rmenv
assumes the path delimeter is forward slash /
(POSIX systems); if you use Windows (path delimeter is backslash \
), replace forward slashes /
in env_path
with backslashes \
.
- Anaconda Documentation
- Conda Documentation
- Getting Started with Conda
- Jupyter Notebook Documentation
- Jupyter Project Documentation [PDF]
- Technical Support - Jupyter Google Group
- Qiskit Documentation
- Documentation for Visual Studio Code
Distributed under the MIT License, Copyright © 2024 Kiran Brahmatewari