thank you for your interest in Graphix!
The aim of graphix is to make the measurement-based quantum computing (MBQC) accessible by creating a one-stop environment to study and research MBQC.
We recommend to fork the repository before working on new features, whether that being an existing issue or your own idea.
Once created, you'll need to clone the repository, and you can follow below to set up the environment. You may want to set up virtual environment, such as conda env or pipenv before setting up the environment.
git clone [email protected]:<username>/graphix.git
cd graphix
pip install -e .[dev]You may want to install additional packages.
Specifically, matplotlib is necessary to run codes in the example folder.
pip install matplotlibFor other depencencies for the docs build, see docs/requirements.txt.
Before comitting the code, make sure to format with ruff.
To format a python file, just run in the top level of the repository:
# Be sure to use the latest version of ruff
pip install -U ruff
# Sort imports and format
ruff check --select I --fix .
ruff format .and you are ready to commit the changes.
When creating a pull request, you'll see default text already filled in to the PR comment box. Please read them and fill in the missing parts, so the motivation and the changes of the PR are clear. Please link to the issue by mentioning the issue number (#10, for example)
Please consider giving the repository a star, as well as citing in your work!