get-started.md

Installation

To install,

pip install git+https://github.com/OpenQuantumDesign/equilux.git

Or clone the repository locally and install with:

git clone https://github.com/OpenQuantumDesign/equilux
pip install .

Documentation

Documentation is implemented with MkDocs and can be read from the docs folder.

To install the dependencies for documentation, run:

pip install -e ".[docs]"

To deploy the documentation server locally:

cp -r examples/ docs/examples/
mkdocs serve