Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make the spelling of "ZXLive" and "ZX-calculus" consistent. #172

Merged
merged 2 commits into from
Nov 9, 2023
Merged
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
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
The [ZX calculus](http://zxcalculus.com) gives us a handy way to represent and work with quantum computations. ZX Live is an interactive tool for working with ZX. Draw graphs or load circuits and apply ZX rules. Intended for experimenting, building proofs, helping to write papers, showing off, or simply learning about ZX and quantum computing. It is powered by the [pyzx](https://github.com/Quantomatic/pyzx) open source library under the hood.
The [ZX-calculus](http://zxcalculus.com) gives us a handy way to represent and work with quantum computations. ZXLive is an interactive tool for working with ZX. Draw graphs or load circuits and apply ZX rules. Intended for experimenting, building proofs, helping to write papers, showing off, or simply learning about ZX and quantum computing. It is powered by the [pyzx](https://github.com/Quantomatic/pyzx) open source library under the hood.

This project is in a pretty early stage, with lots more to come. Have a look at the [Issue Tracker](https://github.com/Quantomatic/zxlive/issues) to see what's in the pipeline.

Expand All @@ -11,5 +11,5 @@ To install from source, you need Python >= 3.9 and pip. If you have those, just
cd zxlive
pip install .

Then, you can run ZX Live by typing `python3 -m zxlive`.
Then, you can run ZXLive by typing `python3 -m zxlive`.

2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ build-backend = "setuptools.build_meta"
[project]
name = "zxlive"
version = "0.1"
description = "An interactive tool for the ZX calculus"
description = "An interactive tool for the ZX-calculus"
readme = "README.md"
requires-python = ">=3.9"
license = { file = "LICENSE" }
Expand Down
2 changes: 1 addition & 1 deletion test/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# zxlive - An interactive tool for the ZX calculus
# zxlive - An interactive tool for the ZX-calculus
# Copyright (C) 2023 - Aleks Kissinger
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand Down
2 changes: 1 addition & 1 deletion test/test_editor_base_panel.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# zxlive - An interactive tool for the ZX calculus
# zxlive - An interactive tool for the ZX-calculus
# Copyright (C) 2023 - Aleks Kissinger
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand Down
2 changes: 1 addition & 1 deletion test/test_mainwindow.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# zxlive - An interactive tool for the ZX calculus
# zxlive - An interactive tool for the ZX-calculus
# Copyright (C) 2023 - Aleks Kissinger
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand Down
2 changes: 1 addition & 1 deletion zxlive/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# zxlive - An interactive tool for the ZX calculus
# zxlive - An interactive tool for the ZX-calculus
# Copyright (C) 2023 - Aleks Kissinger
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand Down
2 changes: 1 addition & 1 deletion zxlive/__main__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# zxlive - An interactive tool for the ZX calculus
# zxlive - An interactive tool for the ZX-calculus
# Copyright (C) 2023 - Aleks Kissinger
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand Down
12 changes: 6 additions & 6 deletions zxlive/app.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# zxlive - An interactive tool for the ZX calculus
# zxlive - An interactive tool for the ZX-calculus
# Copyright (C) 2023 - Aleks Kissinger
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand All @@ -24,22 +24,22 @@


class ZXLive(QApplication):
"""The main ZX Live application
"""The main ZXLive application

...
"""

def __init__(self) -> None:
super().__init__(sys.argv)
self.setApplicationName('ZX Live')
self.setDesktopFileName('ZX Live')
self.setApplicationName('ZXLive')
self.setDesktopFileName('ZXLive')
self.setApplicationVersion('0.1') # TODO: read this from pyproject.toml if possible
self.main_window = MainWindow()

self.lastWindowClosed.connect(self.quit)

parser = QCommandLineParser()
parser.setApplicationDescription("ZX Live - An interactive tool for the ZX calculus")
parser.setApplicationDescription("ZXLive - An interactive tool for the ZX-calculus")
parser.addHelpOption()
parser.addVersionOption()
parser.addPositionalArgument("files", "File(s) to open.", "[files...]")
Expand All @@ -49,7 +49,7 @@ def __init__(self) -> None:


def main() -> None:
"""Main entry point for ZX Live"""
"""Main entry point for ZXLive"""

zxl = ZXLive()
zxl.exec_()
2 changes: 1 addition & 1 deletion zxlive/edit_panel.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@


class GraphEditPanel(EditorBasePanel):
"""Panel for the edit mode of ZX live."""
"""Panel for the edit mode of ZXLive."""

graph_scene: EditGraphScene
start_derivation_signal = Signal(object)
Expand Down
2 changes: 1 addition & 1 deletion zxlive/editor_base_panel.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ class DrawPanelNodeType(TypedDict):

class EditorBasePanel(BasePanel):
"""Base class implementing the shared functionality of graph edit
and rule edit panels of ZX live."""
and rule edit panels of ZXLive."""

graph_scene: EditGraphScene
start_derivation_signal = Signal(object)
Expand Down
2 changes: 1 addition & 1 deletion zxlive/eitem.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# zxlive - An interactive tool for the ZX calculus
# zxlive - An interactive tool for the ZX-calculus
# Copyright (C) 2023 - Aleks Kissinger
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand Down
2 changes: 1 addition & 1 deletion zxlive/graphscene.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# zxlive - An interactive tool for the ZX calculus
# zxlive - An interactive tool for the ZX-calculus
# Copyright (C) 2023 - Aleks Kissinger
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand Down
2 changes: 1 addition & 1 deletion zxlive/graphview.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# zxlive - An interactive tool for the ZX calculus
# zxlive - An interactive tool for the ZX-calculus
# Copyright (C) 2023 - Aleks Kissinger
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand Down
2 changes: 1 addition & 1 deletion zxlive/mainwindow.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# zxlive - An interactive tool for the ZX calculus
# zxlive - An interactive tool for the ZX-calculus
# Copyright (C) 2023 - Aleks Kissinger
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand Down
2 changes: 1 addition & 1 deletion zxlive/proof_panel.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@


class ProofPanel(BasePanel):
"""Panel for the proof mode of ZX live."""
"""Panel for the proof mode of ZXLive."""

def __init__(self, graph: GraphT, *actions: QAction) -> None:
super().__init__(*actions)
Expand Down
2 changes: 1 addition & 1 deletion zxlive/rule_panel.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@


class RulePanel(EditorBasePanel):
"""Panel for the Rule editor of ZX live."""
"""Panel for the Rule editor of ZXLive."""

graph_scene_left: EditGraphScene
graph_scene_right: EditGraphScene
Expand Down
2 changes: 1 addition & 1 deletion zxlive/settings_dialog.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# zxlive - An interactive tool for the ZX calculus
# zxlive - An interactive tool for the ZX-calculus
# Copyright (C) 2023 - Aleks Kissinger
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand Down
2 changes: 1 addition & 1 deletion zxlive/vitem.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# zxlive - An interactive tool for the ZX calculus
# zxlive - An interactive tool for the ZX-calculus
# Copyright (C) 2023 - Aleks Kissinger
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand Down
Loading