Plotting for ZXDiagrams and ZXGraphs, Equality for ZXDiagrams and converting ZX to ZXW #102

contra-bit · 2023-09-25T15:35:08Z

Dear Maintainers,

This pull request introduces several improvements, including the addition of optional plotting functionality for ZXDiagrams and ZXGraphs and closes #101 and fixes #100. The plotting function uses Vega and DataFrames, which will only be loaded when necessary to improve load times and reduce memory usage. The color scheme of spider graphs has been updated to be more accessible for individuals with Color Vision Deficiency (CVD) and improved label readability. Further information on accessibility can be found at <https://zxcalculus.com>.

Additional testing has been implemented for both ZXDiagrams and ZXGraphs, with plots added to most tests and the creation of a new notebook focused on equivalence checking. Existing tutorial notebooks have also been refined, and users will now benefit from automated diagram generation within these notebooks.

Furthermore, the YaoHIR package has gained the capability to import OpenQASM files, enabling easy conversion from openQASM to ZXDiagrams and providing another useful approach to building. optimizing and verifying quantum circuits.

The pull request further includes various bug fixes and improvements, such as addressing issues with the match and apply function for the ZXGraph :id rule, enhancing the overall user experience for plots, resolving testing issues, and handling miscellaneous bugs.

Regards and thanks for reviewing my pull request

replace index based access with get and a default value

exAClior · 2023-09-26T02:23:42Z

Hello @contra-bit , thank you very much for working on adding plot into ZXCalculus.jl. I was trying out the notebook tutorial.jl. I was able to see the new plots, they looked cool! But were you able to install all the required packages that are at the beginning of this notebook? I could not do it. I noticed that you added CompilerPluginTools to dependency. That was causing a little trouble for us. It will probably cause more trouble for us when Julia v1.10 is out. Roger is planning on updating YaoHIR and removing this completely see link. Is this a hard requirement for your future work regarding this dependency?

contra-bit · 2023-09-26T10:37:46Z

Good catch. It is not required.

I only added CompilerPluginTools as an explicit dependency because it was causing trouble for me, when it was being imported as a dependency by YaoHIR.
The import failed because the version required could not be resolved.
The only way for me to resolve the YaoHIR dependency was to add the master branch from the git repo because the julia package had the wrong version.
In order for it to be imported correctly I ran the following command:

pkg> add https://github.com/JuliaCompilerPlugins/CompilerPluginTools.jl

Then I added the equivalent command to the notebook as well.

Pkg.add(url="https://github.com/JuliaCompilerPlugins/CompilerPluginTools.jl")

ChenZhao44 · 2023-09-27T20:44:21Z

@contra-bit Thanks for the PR. I suggest removing the dependency that is only used in the notebook, and keeping the main package as clean as possible. Perhaps it would be better to set up a separate environment in the notebook folder to include CompilerPluginTools and DataFrames.

…into feature/plots

contra-bit · 2024-02-04T22:23:41Z

I am thrilled to share several improvements in this pull request! I have introduced plotting functionality as an optional extension using Vega and DataFrames. This change ensures that these dependencies will only be loaded when needed, leading to faster load times and reduced memory usage.

To enhance accessibility, I have updated the color scheme of spider graphs so that they are distinguishable for people with Color Vision Deficiency (CVD), and improved the readability of phase labels. For further details, kindly consult the accessibility guidelines provided at zxcalculus.com.

My latest contributions enhance testing for both ZXDiagrams and ZXGraphs by adding plots to most tests, along with creating a brand-new notebook dedicated to equivalence checking and refining the existing tutorial notebook. Users will benefit from automatic generation of diagrams within these notebooks.

Moreover, YaoHIR has gained the ability to import OpenQASM files, allowing seamless conversion to ZXDiagrams—providing yet another practical method to construct quantum circuits. I will try to get all my contributions merged and then update the Pkg in the notebooks.

As part of my efforts, I fixed the match and apply function for the ZXGraph :id rule while adding the new equivalence checking functionality. Now, it is possible to determine if two diagrams are identical through the built-in equivalency checks.

Last but not least, I took care of numerous housekeeping tasks such as updating imports, resolving problems discovered during testing, enhancing overall user experience for plots, and dealing with miscellaneous glitches

codecov · 2024-02-05T00:10:15Z

Codecov Report

Attention: 36 lines in your changes are missing coverage. Please review.

Comparison is base (146e39b) 82.49% compared to head (f3f1967) 89.21%.

❗ Current head f3f1967 differs from pull request most recent head f89197d. Consider uploading reports for the commit f89197d to get more accurate results

Files	Patch %	Lines
src/ZX/ir.jl	84.93%	22 Missing ⚠️
src/ZX/zx_diagram.jl	82.89%	13 Missing ⚠️
src/ZX/zx_graph.jl	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #102      +/-   ##
==========================================
+ Coverage   82.49%   89.21%   +6.71%     
==========================================
  Files          28       30       +2     
  Lines        3537     3691     +154     
==========================================
+ Hits         2918     3293     +375     
+ Misses        619      398     -221

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

ChenZhao44 · 2024-02-05T00:27:00Z

@contra-bit Thanks for working on this PR. It looks decent. Before merging this PR, I have only two minor suggestions.

You don't need to keep the original tutorial.jl notebook since it is out-of-date.
There are a lot of indent changes in this PR. The default indent of this repo is 4, but some of the indents are set to 2. These changes have created a lot of unnecessary differences, making it difficult to keep track of the real changes. Could please you fix the indent issue?

Roger-luo · 2024-02-05T01:45:42Z

FYI you don't have to use the package env for notebooks, every Pluto notebook has its own env by default.

contra-bit · 2024-02-07T22:51:38Z

I hope I have fixed the indentation issues, further I have increased the test coverage and added a .JuliaFormatter.toml that species that the default indentation is 4.

The notebooks are now configured to use the Yao upstream repositories.
My next goal is to improve the notebooks and improve the documentation.

Roger-luo · 2024-02-08T15:00:02Z

notebooks/zx_intro.jl

    Pkg.add("OpenQASM")
    Pkg.add("Vega")
    Pkg.add("DataFrames")
-    Pkg.add("YaoHIR.jl")
-    Pkg.add("ZXCalculus.jl")
+    Pkg.add("YaoHIR")
+    Pkg.add("ZXCalculus")
    Pkg.add(
        url = "https://gitlab.informatik.uni-bremen.de/qce/quantumequivalencechecker.jl",
        rev = "feat/zx",


can we use Pluto builtin env instead of doing this?

ChenZhao44

Please address the feedback and resolve the notebook environment issues as pointed out by @Roger-luo

.JuliaFormatter.toml

src/ZX/equality.jl

src/ZX/rules.jl

src/ZX/zx_diagram.jl

src/ZX/rules.jl

ChenZhao44 · 2024-02-17T18:42:48Z

test/circuit_extraction.jl

@@ -38,3 +38,9 @@ zxg2 = clifford_simplification(zxd)

 zxg3 = full_reduction(zxd)
 cir = circuit_extraction(zxg3)
+
+# Plotting
+@test plot(zxd) !== nothing


use isnothing

ChenZhao44 · 2024-02-17T18:44:02Z

test/phase_teleportation.jl

@@ -75,6 +75,8 @@ function gen_cir()
 end

 cir = gen_cir()
+@test plot(cir)!== nothing


use isnothing

ChenZhao44 · 2024-02-17T18:44:08Z

test/plots.jl

+ZX.insert_spider!(zxd, 1, 2, SpiderType.Z)
+zxg = ZXGraph(zxd)
+
+@test plot(zxd) !== nothing


use isnothing

ChenZhao44 · 2024-02-17T18:44:14Z

test/rules.jl

@@ -10,6 +10,7 @@ matches = match(Rule{:f}(), zxd)
 rewrite!(Rule{:f}(), zxd, matches)
 @test sort!(spiders(zxd)) == [1, 3]
 @test phase(zxd, 1) == phase(zxd, 3) == 3 // 4
+@test plot(zxd) !== nothing


use isnothing

ChenZhao44 · 2024-02-17T18:44:52Z

test/zx_diagram.jl

@@ -7,11 +7,13 @@ v_t = [SpiderType.X, SpiderType.Z, SpiderType.X]
 zxd = ZXDiagram(g, v_t, ps)
 zxd2 = ZXDiagram(g, Dict(zip(1:3, v_t)), Dict(zip(1:3, ps)))
 @test zxd.mg == zxd2.mg && zxd.st == zxd2.st && zxd.ps == zxd2.ps
+@test plot(zxd) !== nothing


use isnothing

liam added 4 commits September 24, 2023 22:11

Vega and Compose Plotting and Tutorial

1f0081a

fix ploting when there are no gates

b84fb0a

replace index based access with get and a default value

test ploting for all existing ZXDiagrams

4c5520e

Add Multigraph ZXDiagram to tutorial.jl

fe3785a

contra-bit mentioned this pull request Sep 25, 2023

WIP: Update Tutorial to use Vegaplot #101

Closed

Liam and others added 13 commits February 3, 2024 14:53

add research notebook

b2ec15f

Merge branch 'master' of https://github.com/QuantumBFS/ZXCalculus.jl …

5644989

…into feature/plots

convert plot_vega into an extension

4de1092

fix src and dst bugs

5c96968

add plots for all ZX test

fddac78

integrate equality

e3df9f9

fix id match and rewrite rule

0f549ce

cvd accesible colors for plot

1039ce3

better plot ux

aac3874

ZXW from IR import

227b2c7

fix ir tests by shadowing instrinsic operations

632d6cf

cleanup repo

7196ec4

update notebooks

f3f1967

This was referenced Feb 4, 2024

Add simulation backend for equivalent checking #75

Open

Cannot Plot ZXDiagram with YaoPlots #100

Closed

Liam added 3 commits February 7, 2024 13:33

set default indentation and margin

9b68e3b

apply default indent of 4

b48ae22

use upstream packages

70b3f6c

Liam added 8 commits February 7, 2024 14:23

indent gates_to_circ function

534252a

test plot for ZXGraph

b823482

use upstream packages in notebooks

4a9c382

creat test for BlockIR -> ZXWDiagram -> Matrix

c23c1fb

correct names of Pkgs

2bb9fbf

readd phase test with CodeIR

b9f6a32

improve testcoverage

02e0ba2

add more docstrings

6445b88

contra-bit changed the title ~~Plotting for ZXDiagrams and ZXGraphs~~ Plotting for ZXDiagrams and ZXGraphs, Equality for ZXDiagrams and converting ZX to ZXW Feb 7, 2024

Roger-luo reviewed Feb 8, 2024

View reviewed changes

ChenZhao44 reviewed Feb 17, 2024

View reviewed changes

Liam added 2 commits February 21, 2024 22:39

use builtin pluto env

6dcfc68

remove formater

f89197d

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Plotting for ZXDiagrams and ZXGraphs, Equality for ZXDiagrams and converting ZX to ZXW #102

Plotting for ZXDiagrams and ZXGraphs, Equality for ZXDiagrams and converting ZX to ZXW #102

contra-bit commented Sep 25, 2023 •

edited

exAClior commented Sep 26, 2023

contra-bit commented Sep 26, 2023 •

edited

ChenZhao44 commented Sep 27, 2023

contra-bit commented Feb 4, 2024

codecov bot commented Feb 5, 2024 •

edited

ChenZhao44 commented Feb 5, 2024

Roger-luo commented Feb 5, 2024

contra-bit commented Feb 7, 2024

Roger-luo Feb 8, 2024

ChenZhao44 left a comment

ChenZhao44 Feb 17, 2024

ChenZhao44 Feb 17, 2024

ChenZhao44 Feb 17, 2024

ChenZhao44 Feb 17, 2024

ChenZhao44 Feb 17, 2024

Plotting for ZXDiagrams and ZXGraphs, Equality for ZXDiagrams and converting ZX to ZXW #102

Are you sure you want to change the base?

Plotting for ZXDiagrams and ZXGraphs, Equality for ZXDiagrams and converting ZX to ZXW #102

Conversation

contra-bit commented Sep 25, 2023 • edited

exAClior commented Sep 26, 2023

contra-bit commented Sep 26, 2023 • edited

ChenZhao44 commented Sep 27, 2023

contra-bit commented Feb 4, 2024

codecov bot commented Feb 5, 2024 • edited

Codecov Report

ChenZhao44 commented Feb 5, 2024

Roger-luo commented Feb 5, 2024

contra-bit commented Feb 7, 2024

Roger-luo Feb 8, 2024

Choose a reason for hiding this comment

ChenZhao44 left a comment

Choose a reason for hiding this comment

ChenZhao44 Feb 17, 2024

Choose a reason for hiding this comment

ChenZhao44 Feb 17, 2024

Choose a reason for hiding this comment

ChenZhao44 Feb 17, 2024

Choose a reason for hiding this comment

ChenZhao44 Feb 17, 2024

Choose a reason for hiding this comment

ChenZhao44 Feb 17, 2024

Choose a reason for hiding this comment

contra-bit commented Sep 25, 2023 •

edited

contra-bit commented Sep 26, 2023 •

edited

codecov bot commented Feb 5, 2024 •

edited