feat!: Name change (#116)

* Name change * Remove unused files * Remove reference to readme * Remove parent dir * Add readme * Minimally populate readme
CQCL · Oct 1, 2024 · 5e0e289 · 5e0e289
1 parent 8268adf
commit 5e0e289
Show file tree

Hide file tree

Showing 31 changed files with 31 additions and 309 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -1,7 +1,7 @@
 version: 2
 updates:
   - package-ecosystem: pip
-    directory: "pytket-mbqc-py"
+    directory: "/"
     schedule:
       interval: "weekly"
     target-branch: "main"

diff --git a/.github/workflows/run_tests.yaml b/.github/workflows/run_tests.yaml
@@ -31,10 +31,10 @@ jobs:
           cache: 'pip'
 
       - name: Install pytket-mbqc
-        run: pip install pytket-mbqc-py/
+        run: pip install .
 
       - name: Type Check
-        run: mypy pytket-mbqc-py/pytket_mbqc_py/ --warn-unused-ignores
+        run: mypy ocvqc_py/ --warn-unused-ignores
 
       - name: Lint Check
         run: ruff check
@@ -43,10 +43,10 @@ jobs:
         run: ruff format --check
 
       - name: Run Tests
-        run: pytest --cov-fail-under=100 --cov-report term-missing:skip-covered --cov=pytket-mbqc-py/pytket_mbqc_py/ pytket-mbqc-py/tests/ --durations=10
+        run: pytest --cov-fail-under=100 --cov-report term-missing:skip-covered --cov=ocvqc_py/ tests/ --durations=10
 
       - name: Examples check
-        run: pytest --nbmake pytket-mbqc-py/example_notebooks/*.ipynb
+        run: pytest --nbmake example_notebooks/*.ipynb
 
 
   Build-Documentation:
@@ -64,18 +64,17 @@ jobs:
           cache: 'pip'
 
       - name: Install pytket-benchmarking
-        run: pip install pytket-mbqc-py/
+        run: pip install .
 
       - name: Check Documentation coverage
-        run: docstr-coverage pytket-mbqc-py/pytket_mbqc_py
+        run: docstr-coverage ocvqc_py
 
       - name: Build documentation
         run: |
-          cd pytket-mbqc-py
           make html
 
       - name: Save documentation
         uses: actions/upload-artifact@v4
         with:
           name: docs_html
-          path: pytket-mbqc-py/build/html
+          path: build/html
diff --git a/pytket-mbqc-py/Makefile → Makefile b/pytket-mbqc-py/Makefile → Makefile
diff --git a/README.md b/README.md
@@ -1 +1,9 @@
-# pytket-mbqc
+# ocvqc-py
+
+ocvqc-py (On Chip Verified Quantum Computation - Python) is a python library for creating verifiable MBQC patterns.
+To install ocvqc-py please run
+```
+pip install .
+```
+The library also include a poetry lock file.
+For example usage please see the `example_notebooks` directory.
diff --git a/...c-py/example_notebooks/blind_z_gate.ipynb → example_notebooks/blind_z_gate.ipynb b/...c-py/example_notebooks/blind_z_gate.ipynb → example_notebooks/blind_z_gate.ipynb
@@ -21,7 +21,7 @@
    "source": [
     "from pytket.circuit.display import render_circuit_jupyter\n",
     "\n",
-    "from pytket_mbqc_py import GraphCircuit\n",
+    "from ocvqc_py import GraphCircuit\n",
     "\n",
     "graph_circuit = GraphCircuit(\n",
     "    n_physical_qubits=2,\n",

diff --git a/...y/example_notebooks/verified_z_gate.ipynb → example_notebooks/verified_z_gate.ipynb b/...y/example_notebooks/verified_z_gate.ipynb → example_notebooks/verified_z_gate.ipynb
@@ -20,7 +20,7 @@
    "source": [
     "import pytest\n",
     "\n",
-    "from pytket_mbqc_py import GraphCircuit\n",
+    "from ocvqc_py import GraphCircuit\n",
     "\n",
     "graph_circuit = GraphCircuit(\n",
     "    n_physical_qubits=2,\n",

diff --git a/pytket-mbqc-py/pytket_mbqc_py/__init__.py → ocvqc_py/__init__.py b/pytket-mbqc-py/pytket_mbqc_py/__init__.py → ocvqc_py/__init__.py
diff --git a/pytket-mbqc-py/pytket_mbqc_py/cnot_grid.py → ocvqc_py/cnot_grid.py b/pytket-mbqc-py/pytket_mbqc_py/cnot_grid.py → ocvqc_py/cnot_grid.py
diff --git a/...t-mbqc-py/pytket_mbqc_py/graph_circuit.py → ocvqc_py/graph_circuit.py b/...t-mbqc-py/pytket_mbqc_py/graph_circuit.py → ocvqc_py/graph_circuit.py
@@ -15,7 +15,7 @@
 from pytket.unit_id import Bit, BitRegister, UnitID
 from pytket.utils.outcomearray import OutcomeArray
 
-from pytket_mbqc_py.qubit_manager import QubitManager
+from ocvqc_py.qubit_manager import QubitManager
 
 
 class GraphCircuit(QubitManager):

diff --git a/...t-mbqc-py/pytket_mbqc_py/qubit_manager.py → ocvqc_py/qubit_manager.py b/...t-mbqc-py/pytket_mbqc_py/qubit_manager.py → ocvqc_py/qubit_manager.py
diff --git a/...et-mbqc-py/pytket_mbqc_py/random_graph.py → ocvqc_py/random_graph.py b/...et-mbqc-py/pytket_mbqc_py/random_graph.py → ocvqc_py/random_graph.py
@@ -7,7 +7,7 @@
 
 from numpy.random import Generator, default_rng
 
-from pytket_mbqc_py import GraphCircuit
+from ocvqc_py import GraphCircuit
 
 
 class RandomIdentityGraph(GraphCircuit):

diff --git a/...bqc-py/pytket_mbqc_py/two_qubit_grover.py → ocvqc_py/two_qubit_grover.py b/...bqc-py/pytket_mbqc_py/two_qubit_grover.py → ocvqc_py/two_qubit_grover.py
@@ -3,7 +3,7 @@
 https://journals.aps.org/pra/abstract/10.1103/PhysRevA.104.062422.
 """
 
-from pytket_mbqc_py import GraphCircuit
+from ocvqc_py import GraphCircuit
 
 
 class TwoQubitGrover(GraphCircuit):

diff --git a/pytket-mbqc-py/poetry.lock → poetry.lock b/pytket-mbqc-py/poetry.lock → poetry.lock
diff --git a/pytket-mbqc-py/pyproject.toml → pyproject.toml b/pytket-mbqc-py/pyproject.toml → pyproject.toml
@@ -1,5 +1,5 @@
 [tool.poetry]
-name = "pytket-mbqc-py"
+name = "ocvqc-py"
 version = "0.1.0"
 description = ""
 authors = ["Your Name <[email protected]>"]

diff --git a/pytket-mbqc-py/README.md b/pytket-mbqc-py/README.md
diff --git a/pytket-mbqc-py/example.ipynb b/pytket-mbqc-py/example.ipynb
diff --git a/pytket-mbqc-rus/Cargo.lock b/pytket-mbqc-rus/Cargo.lock
diff --git a/pytket-mbqc-rus/Cargo.toml b/pytket-mbqc-rus/Cargo.toml