Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"sphinx.ext.autosummary",
"sphinx.ext.autosectionlabel",
"sphinx.ext.napoleon",
"sphinx_gallery.gen_gallery",
# "sphinx_gallery.gen_gallery",
]

templates_path = ["_templates"]
Expand Down Expand Up @@ -85,15 +85,15 @@ def setup(app: Sphinx) -> None:

default_role = "any"

sphinx_gallery_conf = {
# path to your example scripts
"examples_dirs": ["../../examples"],
# path to where to save gallery generated output
"gallery_dirs": ["gallery"],
"filename_pattern": "/",
"thumbnail_size": (800, 550),
"parallel": True,
}
# sphinx_gallery_conf = {
# # path to your example scripts
# "examples_dirs": ["../../examples"],
# # path to where to save gallery generated output
# "gallery_dirs": ["gallery"],
# "filename_pattern": "/",
# "thumbnail_size": (800, 550),
# "parallel": True,
# }

suppress_warnings = ["config.cache"]

Expand Down
21 changes: 21 additions & 0 deletions docs/source/development/apiref/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
API Reference
=============
*Coming soon...*

Old API Ref (to be updated):

.. toctree::
:maxdepth: 2

source/generator
source/data
source/modifier
source/simulator
source/graphsim
source/extraction
source/clifford
source/visualization
source/channels
source/random_objects
source/open_graph
source/optimization
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
3 changes: 3 additions & 0 deletions docs/source/development/compatibility.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Compatibility
=============
*Refer to compatiblity.md*
File renamed without changes.
13 changes: 13 additions & 0 deletions docs/source/getting_started.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Getting started
===============

*To be written*

*Simple description of what Graphix does*



Running your first program
--------------------------

*Simple circuit transpilation and pattern simulation*
34 changes: 23 additions & 11 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,23 +1,35 @@
.. graphix documentation master file, created by
sphinx-quickstart on Sun Nov 20 00:43:54 2022.

Graphix - optimizing and simulating MBQC
========================================
Graphix
=======
An open-source framework for Measurement-Based Quantum Computation

**Graphix** is an open-source library to generate, optimize and simulate the measurement-based quantum computing (MBQC) command sequence.
.. toctree::
:caption: Documentation

installation
getting_started
tutorials/index
research_workflows/index

.. toctree::
:caption: Development
:maxdepth: 1
:caption: Documentation

development/contributing
development/compatibility
development/apiref/index

tutorial
gallery/index
references
contributing

.. toctree::
:maxdepth: 2
:caption: Introduction to LC-MBQC
:caption: Graphix plugins

plugins/index

.. toctree::
:caption: Old sections

tutorial
intro
lc-mbqc
lc-mbqc
4 changes: 4 additions & 0 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Installation
============

*To be written*
3 changes: 3 additions & 0 deletions docs/source/plugins/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Graphix plugins
===============
*Coming soon...*
18 changes: 0 additions & 18 deletions docs/source/references.rst

This file was deleted.

3 changes: 3 additions & 0 deletions docs/source/research_workflows/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Research workflows
==================
*Coming soon...*
4 changes: 2 additions & 2 deletions docs/source/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Tutorial
Graphix provides a high-level interface to generate, optimize and classically simulate the measurement-based quantum computing (MBQC).

In this tutorial, we look at how to program MBQC using graphix library.
We will explain the basics here along with the code, and you can go to :doc:`intro` to learn more about the theoretical background of MBQC and :doc:`references` for module references.
We will explain the basics here along with the code, and you can go to :doc:`intro` to learn more about the theoretical background of MBQC and references for module references.

Generating measurement patterns
-------------------------------
Expand Down Expand Up @@ -229,7 +229,7 @@ With this, we only need the memory space for three qubits.

This procedure is more effective when the resource state size is large compared to the logical input qubit count;
for example, the three-qubit `quantum Fourier transform (QFT)
<https://en.wikipedia.org/wiki/Quantum_Fourier_transform>`_ circuit requires 12 qubits in the resource state after :meth:`~graphix.pattern.Pattern.perform_pauli_measurements()` (see the code in :ref:`QFT example <sphx_glr_gallery_qft_with_tn.py>`); with the proper reordering of the commands, the max_space reduces to 4.
<https://en.wikipedia.org/wiki/Quantum_Fourier_transform>`_ circuit requires 12 qubits in the resource state after :meth:`~graphix.pattern.Pattern.perform_pauli_measurements()` (see the code in sphx_glr_gallery_qft_with_tn.py); with the proper reordering of the commands, the max_space reduces to 4.
In fact, for patterns transpiled from gate network, the minimum *space* we can realize is typically :math:`n_w+1` where :math:`n_w` is the width of the circuit.


Expand Down
21 changes: 21 additions & 0 deletions docs/source/tutorials/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Tutorials
=========

*Overview of MBQC, we can borrow beginning of Sec. 2*

.. toctree::
source/graph_mbqc
source/measurement_calculus
source/transpilation
source/flows
source/pattern_standardization
source/space_minimization
source/pauli_removal
source/pattern_simulation
source/circuit_extraction

.. toctree::
:caption: Advanced Tutorials

source/symbolic
source/type_safety
2 changes: 2 additions & 0 deletions docs/source/tutorials/source/circuit_extraction.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Circuit extraction
==================
4 changes: 4 additions & 0 deletions docs/source/tutorials/source/flows.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Flows and determinism
=====================

*This tutorial should cover sections 2.3 and 3.2 of the paper.*
6 changes: 6 additions & 0 deletions docs/source/tutorials/source/graph_mbqc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Open graphs and correction functions
====================================

*This tutorial should cover section 2.1 of the paper, a bit less of theory and some more examples*


6 changes: 6 additions & 0 deletions docs/source/tutorials/source/measurement_calculus.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Patterns and the measurement calculus
=====================================

*This tutorial should cover section 2.2 of the paper without standardization.*
*Instead of simulating the pattern (box 2.2), we can put a pattern visualization*

5 changes: 5 additions & 0 deletions docs/source/tutorials/source/pattern_simulation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Pattern simulation
===================

*This tutorial could start with a simple pattern simulation example (like in "Getting started"), then cover sections 3.6. No need to put the Figure.*
*There should be subsections: branch selection, noisy simulation and maybe "Advance usage" : custom noise models.*
3 changes: 3 additions & 0 deletions docs/source/tutorials/source/pattern_standardization.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Pattern standardization
=======================
*Basic example and maybe some details on `StandardizedPattern` class*
2 changes: 2 additions & 0 deletions docs/source/tutorials/source/pauli_removal.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Pauli measurement removal
=========================
3 changes: 3 additions & 0 deletions docs/source/tutorials/source/space_minimization.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Space minimization
==================
*Basic example and details on `SpaceMinimizationHeuristic`*
2 changes: 2 additions & 0 deletions docs/source/tutorials/source/symbolic.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Symbolic manipulation
=====================
3 changes: 3 additions & 0 deletions docs/source/tutorials/source/transpilation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
From circuits to patterns
=========================
*This tutorial should describe the JCZ transpiler and the Circuit API. Fig. 7 is potentially useful*
3 changes: 3 additions & 0 deletions docs/source/tutorials/source/type_safety.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Type safety
===========
*Description of type hierachies*
Loading