Hitchhiker's Guide to the Quantum Realm ⚛

My field notes on quantum computing with IBM's Qiskit...

This repository is a work in progress.

Setup

Prerequisites

You must have the following installed on your system to get started:

1. Git version control system
2. Python (recommended to have a version greater than 3.9.0)

To setup this project locally on your machine, follow these steps:

1. Clone Project

Clone this repo to a desired location (folder) on your machine by opening up a terminal from the folder and entering the following command:

git clone https://github.com/ravi-aratchige/hitchhikers-guide-to-the-quantum-realm.git

Next, move into the project directory:

cd hitchhikers-guide-to-the-quantum-realm

2. Activate Virtual Environment

A virtual environment will help you keep the project's dependencies isolated from the global system of Python packages. To setup your virtual environment, first ensure that virtualenv is installed on your system:

pip install virtualenv

To create and activate a virtual environment, enter the following commands after moving into the spacefarer folder as done in the previous step:

# Create a virtual environment named 'env':
python -m venv env

# Activate the virtual environment (Windows):
env\Scripts\activate.bat

# Activate the virtual environment (MacOS / Linux):
source env/bin/activate

Your terminal will now include an (env) prefix, indicating a successful activation of the virtual environment:

# On Windows:
(env) drive:\folder\...hitchhikers-guide-to-the-quantum-realm>

# On MacOS and Linux
(env) user@computer:~/...hitchhikers-guide-to-the-quantum-realm$

To deactivate the virtual environment (and remove the (env) prefix):

deactivate

3. Install Dependencies

After activating the virtual environment, you can install all of the necessary dependencies with a single command:

pip install -r requirements.txt

requirements.txt includes all of the project's dependencies and their respective versions.

4. Start Jupyter Server

You can start the Jupyter Server to view and run the notebooks after the dependencies have been successfully installed:

jupyter notebook

Jupyter Server will then start on http://localhost:8888/tree.