Installation#

Let’s get started using MIMIQ Circuits Python!

MIMIQ Circuits is compatible with Python 3.9 or later versions. To get started, ensure that you have Python installed on your local system. You can download Python from Python Download.

For a smoother interaction, we recommend using Jupyter, an interactive computing environment. Install Jupyter by following the instructions at Jupyter Installation.

To isolate MIMIQ Circuits and avoid conflicts, consider using Python virtual environments. Create a minimal environment with only Python installed using Python’s built-in virtual environment tool. For guidance, refer to Python virtual environments.

Since MIMIQ Circuits is still in rapid development, we prefer to directly install the latest available version directly from the GitHub repository. In order to do so, git needs to be installed. Please refer to the Git Book for the installation instructions.

To set up a minimal environment with only Python installed and begin using MIMIQ Circuits, follow these steps:

Create a minimal environment

Unix (Linux / MacOS)

python3 -m venv /path/to/virtual/environment

Windows

python3 -m venv c:\path\to\virtual\environment

Activate the newly created environment:

Unix (Linux / MacOS)

source /path/to/virtual/environment/bin/activate

Windows

source c:\path\to\virtual\environment\bin\Activate.ps1

Install MIMIQ Circuits:

pip3 install "mimiqcircuits @ git+https://github.com/qperfect-io/mimiqcircuits-python.git"

Verify the installed packages in your virtual environment:

pip3 list

If you plan to use visualization functionality or work with Jupyter notebooks, it is recommended to install the extra support for visualization:

pip3 install "mimiqcircuits[visualization] @ git+https://github.com/qperfect-io/mimiqcircuits-python.git"

Warning

Jupyter Kernel

If you are using Jupyter, you need to install the Jupyter kernel for your virtual environment. To do this, run the following command:

python3 -m ipykernel install --user --name=<name of your virtual environment>

You can now use the virtual environment in Jupyter by selecting the corresponding kernel from the Kernel menu.

With these steps completed, you are now ready to explore the features and capabilities of MIMIQ Circuits within your Python virtual environment. Happy coding!