docs: Change to new proposed structure

docs/source/conf.py

@@ -12,32 +12,33 @@
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
-
-extensions = ["autodoc2", "myst_nb", "sphinx.ext.intersphinx"]
+add_module_names = False
+extensions = ["autodoc2", "myst_nb", "sphinx.ext.intersphinx", "sphinx.ext.mathjax"]
+latex_engine = "xelatex"
 autodoc2_packages = [
     "../../tierkreis/tierkreis",
     {
-        "path": "../../tierkreis_workers/aer_worker/src/impl/aer_worker_impl.py",
+        "path": "../../tierkreis_workers/aer_worker/tkr_aer_worker_impl/impl.py",
         "module": "aer_worker",
     },
     {
-        "path": "../../tierkreis_workers/ibmq_worker/src/impl/ibmq_worker_impl.py",
-        "module": "ibmq_worker",
+        "path": "../../tierkreis_workers/ibmq_worker/tkr_ibmq_worker_impl/impl.py",
+        "module": "ibmq_worker.tkr_ibmq_worker_impl.impl",
     },
     {
-        "path": "../../tierkreis_workers/nexus_worker/src/impl/nexus_worker_impl.py",
+        "path": "../../tierkreis_workers/nexus_worker/tkr_nexus_worker_impl/impl.py",
         "module": "nexus_worker",
     },
     {
-        "path": "../../tierkreis_workers/pytket_worker/src/impl/pytket_worker_impl.py",
-        "module": "pytket_worker",
+        "path": "../../tierkreis_workers/pytket_worker/tkr_pytket_worker_impl/impl.py",
+        "module": "pytket_worker.tkr_pytket_worker_impl.impl",
     },
     {
-        "path": "../../tierkreis_workers/quantinuum_worker/src/impl/quantinuum_worker_impl.py",
-        "module": "quantinuum_worker",
+        "path": "../../tierkreis_workers/quantinuum_worker/tkr_quantinuum_worker_impl/impl.py",
+        "module": "quantinuum_worker.tkr_quantinuum_worker_impl.impl",
     },
     {
-        "path": "../../tierkreis_workers/qulacs_worker/src/impl/qulacs_worker_impl.py",
+        "path": "../../tierkreis_workers/qulacs_worker/tkr_qulacs_worker_impl/impl.py",
         "module": "qulacs_worker",
     },
 ]
@@ -54,6 +55,7 @@
     "storage_and_executors.ipynb",
     "hpc.ipynb",
 ]
+myst_enable_extensions = ["dollarmath", "amsmath"]
 
 nitpicky = True
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "examples/**/.venv/**"]

docs/source/examples/api/stubs.py

@@ -0,0 +1,17 @@
+"""Code generated from hello_world_worker namespace. Please do not edit."""
+
+from typing import NamedTuple
+from tierkreis.controller.data.models import TKR
+
+
+class greet(NamedTuple):
+    greeting: TKR[str]  # noqa: F821 # fmt: skip
+    subject: TKR[str]  # noqa: F821 # fmt: skip
+
+    @staticmethod
+    def out() -> type[TKR[str]]:  # noqa: F821 # fmt: skip
+        return TKR[str]  # noqa: F821 # fmt: skip
+
+    @property
+    def namespace(self) -> str:
+        return "hello_world_worker"

docs/source/examples/errors_and_debugging.ipynb

@@ -93,7 +93,7 @@
         "\n",
         "The first avenue for debugging is enabling fine grained logging.\n",
         "The tierkreis logging inherits properties from the root logger so it suffices to set a `basicConfig` which changes **only** the logger of the controller.\n",
-        "When running a python worker, Tierkreis will check the environment variables `$TKR_LOG_LEVEL`, `$TKR_LOG_FORMAT` and `$TKR_DATE_FORMAT` for logger information as detailed [here](../logging_and_errors.md)."
+        "When running a python worker, Tierkreis will check the environment variables `$TKR_LOG_LEVEL`, `$TKR_LOG_FORMAT` and `$TKR_DATE_FORMAT` for logger information as detailed [here](../tutorial/logging_and_errors.md)."
       ]
     },
     {

docs/source/examples/example_workers/multiple_outputs_worker/api/pyproject.toml

@@ -1,7 +1,6 @@
 [project]
 name = "tkr-multiple-outputs-worker"
 version = "0.1.0"
-readme = "README.md"
 requires-python = ">=3.12"
 dependencies = [
     "tierkreis",

docs/source/examples/example_workers/multiple_outputs_worker/pyproject.toml

@@ -2,7 +2,6 @@
 name = "tkr-multiple-outputs-worker-impl"
 version = "0.2.0"
 description = "A tierkreis worker implementation."
-readme = "README.md"
 requires-python = ">=3.12"
 dependencies = [
     "tierkreis",

docs/source/examples/example_workers/pytket_example_worker/api/api.py

@@ -0,0 +1,43 @@
+"""Code generated from pytket_example_worker namespace. Please do not edit."""
+
+from typing import NamedTuple
+from tierkreis.controller.data.models import TKR, OpaqueType
+
+
+class substitute(NamedTuple):
+    circuit: TKR[OpaqueType["pytket._tket.circuit.Circuit"]]  # noqa: F821 # fmt: skip
+    a: TKR[float]  # noqa: F821 # fmt: skip
+    b: TKR[float]  # noqa: F821 # fmt: skip
+    c: TKR[float]  # noqa: F821 # fmt: skip
+
+    @staticmethod
+    def out() -> type[TKR[OpaqueType["pytket._tket.circuit.Circuit"]]]:  # noqa: F821 # fmt: skip
+        return TKR[OpaqueType["pytket._tket.circuit.Circuit"]]  # noqa: F821 # fmt: skip
+
+    @property
+    def namespace(self) -> str:
+        return "pytket_example_worker"
+
+
+class simulate(NamedTuple):
+    circuit: TKR[OpaqueType["pytket._tket.circuit.Circuit"]]  # noqa: F821 # fmt: skip
+
+    @staticmethod
+    def out() -> type[TKR[OpaqueType["pytket.backends.backendresult.BackendResult"]]]:  # noqa: F821 # fmt: skip
+        return TKR[OpaqueType["pytket.backends.backendresult.BackendResult"]]  # noqa: F821 # fmt: skip
+
+    @property
+    def namespace(self) -> str:
+        return "pytket_example_worker"
+
+
+class optimise(NamedTuple):
+    circuit: TKR[OpaqueType["pytket._tket.circuit.Circuit"]]  # noqa: F821 # fmt: skip
+
+    @staticmethod
+    def out() -> type[TKR[OpaqueType["pytket._tket.circuit.Circuit"]]]:  # noqa: F821 # fmt: skip
+        return TKR[OpaqueType["pytket._tket.circuit.Circuit"]]  # noqa: F821 # fmt: skip
+
+    @property
+    def namespace(self) -> str:
+        return "pytket_example_worker"

docs/source/examples/example_workers/pytket_example_worker/api/pyproject.toml

@@ -0,0 +1,17 @@
+[project]
+name = "tkr-pytket-example-worker"
+version = "0.2.0"
+requires-python = ">=3.12"
+dependencies = [
+    "tierkreis",
+]
+
+[tool.uv.sources]
+tierkreis = { path = "../../../../../../tierkreis", editable = true }
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel.force-include]
+"api.py" = "pytket_example_worker.py"

docs/source/examples/example_workers/pytket_example_worker/pyproject.toml

@@ -0,0 +1,26 @@
+[project]
+name = "tkr-pytket-example-worker-impl"
+version = "0.1.0"
+requires-python = ">=3.12"
+dependencies = [
+    "pydantic>=2.11.7",
+    "pytket>=2.9.3",
+    "tierkreis",
+    "ruff",
+    "sympy",
+    "pytket-qiskit",
+    "tkr-pytket-example-worker",
+]
+
+[tool.uv.sources]
+tierkreis = { workspace = true }
+tkr-pytket-example-worker = { workspace = true }
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+
+
+[project.scripts]
+tkr-pytket-example-worker = "tkr_pytket_example_worker_impl.main:main"

docs/source/examples/example_workers/pytket_example_worker/tkr_pytket_example_worker_impl/__init__.py

@@ -0,0 +1,3 @@
+from .impl import worker
+
+__all__ = ["worker"]

docs/source/examples/example_workers/pytket_example_worker/tkr_pytket_example_worker_impl/impl.py

@@ -0,0 +1,31 @@
+import logging
+
+from pytket._tket.circuit import Circuit
+from pytket.backends.backendresult import BackendResult
+from pytket.extensions.qiskit.backends.aer import AerBackend
+from pytket.transform import Transform
+from sympy import Symbol
+
+from tierkreis import Worker
+
+logger = logging.getLogger(__name__)
+
+worker = Worker("pytket_example_worker")
+
+
+@worker.task()
+def substitute(circuit: Circuit, a: float, b: float, c: float) -> Circuit:
+    circuit.symbol_substitution({Symbol("a"): a, Symbol("b"): b, Symbol("c"): c})
+    return circuit
+
+
+@worker.task()
+def simulate(circuit: Circuit) -> BackendResult:
+    backend = AerBackend()
+    return backend.run_circuit(circuit, n_shots=1000)
+
+
+@worker.task()
+def optimise(circuit: Circuit) -> Circuit:
+    Transform.OptimisePhaseGadgets().apply(circuit)
+    return circuit

docs/source/examples/example_workers/pytket_example_worker/tkr_pytket_example_worker_impl/main.py

@@ -0,0 +1,11 @@
+from sys import argv
+
+from tkr_pytket_example_worker_impl import worker
+
+
+def main():
+    worker.app(argv)
+
+
+if __name__ == "__main__":
+    main()