qref 0.1.0__py3-none-any.whl

qref/__init__.py

@@ -0,0 +1,44 @@
+# Copyright 2024 PsiQuantum, Corp.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Public API of QREF."""
+
+from typing import Any
+
+from ._schema_v1 import SchemaV1, generate_schema_v1
+
+SCHEMA_GENERATORS = {"v1": generate_schema_v1}
+MODELS = {"v1": SchemaV1}
+LATEST_SCHEMA_VERSION = "v1"
+
+
+def generate_program_schema(version: str = LATEST_SCHEMA_VERSION) -> dict[str, Any]:
+    """Generate Program schema of given version.
+
+    Args:
+        version: version identifier of the schema.
+
+    Returns:
+        A dictionary with JSON schema describing program.
+
+    Raises:
+        ValueError: if `version` does not match any known version schema.
+    """
+    try:
+        return SCHEMA_GENERATORS[version]()
+    except KeyError:
+        raise ValueError(f"Unknown schema version {version}")
+
+
+__all__ = ["generate_program_schema", "SchemaV1"]

qref/_schema_v1.py

@@ -0,0 +1,113 @@
+# Copyright 2024 PsiQuantum, Corp.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Pydantic models used for defining V1 schema of Routine."""
+
+from __future__ import annotations
+
+from typing import Annotated, Any, Literal, Optional, Union
+
+from pydantic import BaseModel, ConfigDict, Field, StringConstraints
+from pydantic.json_schema import GenerateJsonSchema
+
+NAME_PATTERN = "[A-Za-z_][A-Za-z0-9_]*"
+NAMESPACED_NAME_PATTERN = rf"{NAME_PATTERN}\.{NAME_PATTERN}"
+
+Name = Annotated[str, StringConstraints(pattern=rf"^{NAME_PATTERN}$")]
+NamespacedName = Annotated[str, StringConstraints(pattern=rf"^{NAMESPACED_NAME_PATTERN}")]
+OptionallyNamespacedName = Annotated[
+    str, StringConstraints(pattern=rf"^(({NAME_PATTERN})|({NAMESPACED_NAME_PATTERN}))$")
+]
+_Value = Union[int, float, str]
+
+
+class _PortV1(BaseModel):
+    name: Name
+    direction: Literal["input", "output", "through"]
+    size: Optional[_Value]
+    model_config = ConfigDict(title="Port")
+
+
+class _ConnectionV1(BaseModel):
+    source: OptionallyNamespacedName
+    target: OptionallyNamespacedName
+
+    model_config = ConfigDict(title="Connection", use_enum_values=True)
+
+
+class _ResourceV1(BaseModel):
+    name: Name
+    type: Literal["additive", "multiplicative", "qubits", "other"]
+    value: Union[int, float, str, None]
+
+    model_config = ConfigDict(title="Resource")
+
+
+class _ParamLinkV1(BaseModel):
+    source: Name
+    targets: list[NamespacedName]
+
+    model_config = ConfigDict(title="ParamLink")
+
+
+class RoutineV1(BaseModel):
+    """Description of Routine in V1 schema.
+
+    Note:
+        This is NOT a top-level object in the schema. Instead, RoutineV1 is wrapped in
+        SchemaV1.
+    """
+
+    name: Name
+    children: list[RoutineV1] = Field(default_factory=list)
+    type: Optional[str] = None
+    ports: list[_PortV1] = Field(default_factory=list)
+    resources: list[_ResourceV1] = Field(default_factory=list)
+    connections: list[_ConnectionV1] = Field(default_factory=list)
+    input_params: list[Name] = Field(default_factory=list)
+    local_variables: list[str] = Field(default_factory=list)
+    linked_params: list[_ParamLinkV1] = Field(default_factory=list)
+    meta: dict[str, Any] = Field(default_factory=dict)
+
+    model_config = ConfigDict(title="Routine")
+
+    def __init__(self, **data: Any):
+        super().__init__(**{k: v for k, v in data.items() if v != [] and v != {}})
+
+
+class SchemaV1(BaseModel):
+    """Root object in Program schema V1."""
+
+    version: Literal["v1"]
+    program: RoutineV1
+
+
+class _GenerateV1JsonSchema(GenerateJsonSchema):
+    def generate(self, schema, mode="validation"):
+        json_schema = super().generate(schema, mode=mode)
+        json_schema["title"] = "FTQC-ready quantum program"
+        json_schema["$schema"] = self.schema_dialect
+        return json_schema
+
+    def normalize_name(self, name):
+        return name.removeprefix("_").replace("V1", "")
+
+
+def generate_schema_v1() -> dict[str, Any]:
+    """Generate Routine schema V1.
+
+    The schema is generated from DocumentRootV1 model, and then enriched with
+    additional fields "title" and "$schema".
+    """
+    return SchemaV1.model_json_schema(schema_generator=_GenerateV1JsonSchema)

qref/experimental/__init__.py

@@ -0,0 +1,14 @@
+# Copyright 2024 PsiQuantum, Corp.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+

qref/experimental/rendering.py

@@ -0,0 +1,182 @@
+# Copyright 2024 PsiQuantum, Corp.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Experimental visualization capabilities for QREF.
+
+Currently, the visualizations are done with graphviz, which does not suport
+hierarchical structures. Therefore, we have to use a somewhat hacky representation
+of our routines:
+
+- The leaf nodes are drawn as a single graphviz node (this is not surprising) with
+  Mrecord shape. This allows to visually separate routine name from its ports.
+- The non-leaf nodes are represented as clusters.
+  - Clusters can't use Mrecord shape, and so the ports are drawn as separate nodes.
+  - Input and output ports are grouped into subgraphs with the same rank, which
+    forces all inputs / all outputs to be placed in a single column.
+
+Because of the above dichotomy, care has to be taken when constructing edges.
+- If addressing port of a leaf, it must be specified as graphviz port, e.g:
+  "root.child:in_0"
+- If addressing port of a non-leaf, you use normal node reference, e.g:
+  "root.child.in_0"
+"""
+
+from argparse import ArgumentParser
+from pathlib import Path
+from typing import Union
+
+import graphviz
+import yaml
+
+from .. import SchemaV1
+
+# Dictionary of default graph attributes, used for non-leaf nodes
+GRAPH_ATTRS = {
+    "rankdir": "LR",  # Draw left to right (default is top to bottom)
+    "fontname": "Helvetica",
+}
+
+# Keyword args passed to dag.node for drawing leaf nodes
+LEAF_NODE_KWARGS = {
+    "shape": "Mrecord",  # Allow drawing leafs split into labels/ports
+    "style": "bold",  # Bold border
+    "color": "#0288f5",  # Nice blue color
+    "fontsize": "12",  # Larger font size then e.g. ports of non-leafs
+}
+
+# Keyword args passed to dag.node for drawing ports of non-leaf nodes
+PORT_NODE_KWARGS = {
+    "style": "bold",  # Bold border
+    "color": "#ffa44a",  # Orange border color
+    "fontsize": "10",  # Smaller font size than the rest of the graph
+    "shape": "circle",
+}
+
+# Additional attributes of subgraphs of ports (ports of the same direction
+# are grouped into such subgraphs)
+PORT_GROUP_ATTRS = {"rank": "same"}  # Place all ports in the group in the same column
+
+# Additional kwargs passed to dag.subgraph for defining non-leaf clusters
+CLUSTER_KWARGS = {"style": "rounded"}  # Make cluster edges rounded
+
+
+def _format_node_name(node_name, parent):
+    """Given a node name and a parent container, format it accordingly.
+
+    Read the module-level docstring for explanation why different port formats
+    of ports are being used.
+    """
+    if "." not in node_name:  # Case 1: parent port (=> port is a graphviz node)
+        return node_name
+
+    # Resolve the child, assume the graph is correct and thus the child exists.
+    child_name, port_name = node_name.split(".")
+    child = next(iter((child for child in parent.children if child.name == child_name)))
+    if child.children:  # Case 2: port of non-leaf child (=> port is a graphviz node)
+        return node_name
+    else:  # Case 3: port of leaf child (=> port is an actual port of Mrecord, use ":")
+        return f"{child_name}:{port_name}"
+
+
+def _add_nonleaf_ports(ports, parent_cluster, parent_path: str, group_name):
+    with parent_cluster.subgraph(
+        name=f"{parent_path}:{group_name}", graph_attr=PORT_GROUP_ATTRS
+    ) as subgraph:
+        for port in ports:
+            subgraph.node(name=f"{parent_path}.{port.name}", label=port.name, **PORT_NODE_KWARGS)
+
+
+def _split_ports(ports):
+    input_ports = []
+    output_ports = []
+    for port in ports:
+        if port.direction == "input":
+            input_ports.append(port)
+        elif port.direction == "output":
+            output_ports.append(port)
+        else:
+            raise ValueError("Bi-directional ports are not yet supported for rendering")
+    return input_ports, output_ports
+
+
+def _add_nonleaf(routine, dag: graphviz.Digraph, parent_path: str) -> None:
+    input_ports, output_ports = _split_ports(routine.ports)
+    full_path = f"{parent_path}.{routine.name}"
+
+    with dag.subgraph(
+        name=f"cluster_{full_path}", graph_attr={"label": routine.name, **CLUSTER_KWARGS}
+    ) as cluster:
+        _add_nonleaf_ports(input_ports, cluster, full_path, "inputs")
+        _add_nonleaf_ports(output_ports, cluster, full_path, "outputs")
+
+        for child in routine.children:
+            _add_routine(child, cluster, f"{parent_path}.{routine.name}")
+
+        for connection in routine.connections:
+            cluster.edge(
+                full_path + "." + _format_node_name(connection.source, routine),
+                full_path + "." + _format_node_name(connection.target, routine),
+            )
+
+
+def _ports_row(ports) -> str:
+    return "{" + "|".join(f"<{port.name}> {port.name}" for port in ports) + "}"
+
+
+def _add_leaf(routine, dag: graphviz.Digraph, parent_path: str) -> None:
+    input_ports, output_ports = _split_ports(routine.ports)
+    label = f"{{ {_ports_row(input_ports)} | {routine.name } | {_ports_row(output_ports)} }}"
+    dag.node(".".join((parent_path, routine.name)), label=label, **LEAF_NODE_KWARGS)
+
+
+def _add_routine(routine, dag: graphviz.Digraph, parent_path: str = "") -> None:
+    if routine.children:
+        _add_nonleaf(routine, dag, parent_path)
+    else:
+        _add_leaf(routine, dag, parent_path)
+
+
+def _ensure_schema_v1(data: Union[dict, SchemaV1]) -> SchemaV1:
+    return data if isinstance(data, SchemaV1) else SchemaV1(**data)
+
+
+def to_graphviz(data: Union[dict, SchemaV1]) -> graphviz.Digraph:
+    """Convert routine encoded with v1 schema to a graphviz DAG."""
+    data = _ensure_schema_v1(data)
+    dag = graphviz.Digraph(graph_attr=GRAPH_ATTRS)
+    _add_routine(data.program, dag)
+    return dag
+
+
+def render_entry_point():
+    parser = ArgumentParser()
+    parser.add_argument(
+        "input", help="Path to the YAML or JSON file with Routine in V1 schema", type=Path
+    )
+    parser.add_argument(
+        "output",
+        help=(
+            "Path to the output file. File format is determined based on the extension, "
+            "which should be either .svg or .pdf"
+        ),
+        type=Path,
+    )
+
+    args = parser.parse_args()
+
+    with open(args.input) as f:
+        routine = SchemaV1.model_validate(yaml.safe_load(f))
+
+    dag = to_graphviz(routine)
+    dag.render(args.output.with_suffix(""), format=args.output.suffix.strip("."))

qref-0.1.0.dist-info/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

qref-0.1.0.dist-info/METADATA

@@ -0,0 +1,161 @@
+Metadata-Version: 2.1
+Name: qref
+Version: 0.1.0
+Summary: Quantum Resource Estimation Format
+License: Apache 2.0
+Author: PsiQuantum, Corp.
+Requires-Python: >=3.9,<4.0
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: graphviz (>=0.20.3,<0.21.0)
+Requires-Dist: pydantic (>=2.0,<3.0)
+Description-Content-Type: text/markdown
+
+# QREF
+Quantum Resource Estimation Format (QREF) is an open format for representing
+quantum algorithms, optimized for usage in quantum resource estimation (QRE).
+
+QREF comprises:
+
+- Definition of data format, formalized as a JSON schema.
+- A Python library for validation of quantum programs written in QREF format using [Pydantic](https://docs.pydantic.dev/).
+- Rudimentary visualization tool `qref-render`.
+
+## Installation
+
+Using QREF data format does not require installation - you can easily write quantum
+programs in YAML or JSON.
+
+To install QREF Python package, clone this repository and install it as usual with `pip`:
+
+```bash
+# Clone QREF repo (you can use HTTP link as well)
+git clone git@github.com:PsiQ/qref.git
+cd qref
+pip install .
+```
+
+## QREF format
+
+QREF format represents quantum programs as a hierarchical directed acyclic graphs (DAGs).
+That's a mouthful, so let us unpack what it means:
+
+- *hierarchical*: each node can contain subgraphs, i.e. routines can be nested inside
+  larger routines.
+- *directed*: information flow is unidirectional, and the direction is unambiguous.
+- *acyclic*: meaning there are no loops.
+
+Consider the following hierarchical DAG of a hypothetical quantum program:
+
+![program example](example_routine.svg)
+
+It can be succinctly written in QREF format as:
+
+
+```yaml
+version: v1
+program:
+  name: my_algorithm
+  ports:
+  - direction: input
+    name: in_0
+    size: 2
+  - direction: input
+    name: in_1
+    size: 2
+  - direction: output
+    name: out_0
+    size: 4
+  children:
+  - name: subroutine_1
+    ports:
+    - direction: input
+      name: in_0
+      size: 2
+    - direction: output
+      name: out_0
+      size: 3
+  - name: subroutine_2
+    ports:
+    - direction: input
+      name: in_0
+      size: 2
+    - direction: output
+      name: out_0
+      size: 1
+    - direction: output
+      name: out_1
+      size: 1
+  - name: merge
+    ports:
+    - direction: input
+      name: in_0
+      size: 1
+    - direction: input
+      name: in_1
+      size: 1
+    - direction: input
+      name: in_2
+      size: 2
+    - direction: output
+      name: out_0
+      size: 4
+  connections:
+  - source: in_0
+    target: subroutine_1.in_0
+  - source: in_1
+    target: subroutine_2.in_0
+  - source: subroutine_1.out_0
+    target: merge.in_2
+  - source: subroutine_2.out_0
+    target: merge.in_0
+  - source: subroutine_2.out_1
+    target: merge.in_1
+  - source: merge.out_0
+    target: out_0
+```
+
+
+For full description of QREF format, check our [docs](https://example.com).
+
+## Using QREF package
+
+### Using JSON schema for validating data in QREF format
+
+JSON schema for QREF format can be obtained by calling `generate_program_schema` function.
+Such schema can be then used for validating user's input, e.g. using `jsonschema` package:
+
+```python
+from jsonschema import validate
+from qref import generate_program_schema
+
+# Hypothetical function loading your data as native Python dictionary.
+data = load_some_program()
+schema = generate_program_schema()
+
+# This will raise if there are some validation errors.
+validate(schema, data)
+```
+
+### Validation using Pydantic models
+
+If you are familiar with Pydantic, you might find it easier to work with QREF Pydantic
+models instead of interacting with JSON schema directly. In the example below, we create
+an instance of `SchemaV1` model from validated data stored in QREF format:
+
+```python
+from qref import SchemaV1
+
+data = load_some_program()
+
+# This will raise if data is not valid
+program = SchemaV1.model_validate(data)
+```
+
+## Development
+
+In order to install development environment or build documentation locally, please refer to [Development Guide](TODO).

qref-0.1.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+qref/__init__.py,sha256=uMtizSoCcJi9QCmf63qQRA1lw8EsBHrx0CP9asheLUc,1342
+qref/_schema_v1.py,sha256=mauU9DaIBbhuhPa5zfKQSC9psjbvt9SgzWo87iwiYd8,3684
+qref/experimental/__init__.py,sha256=3FgqI0lVKJqOfNerLss4QDdJaeFW_3RcO31mvZI6ax0,582
+qref/experimental/rendering.py,sha256=XHNauOlSpYUGn_jKEIBnh0l1wERG2q8lqXzNRlNgVcM,6805
+qref-0.1.0.dist-info/LICENSE,sha256=QwcOLU5TJoTeUhuIXzhdCEEDDvorGiC6-3YTOl4TecE,11356
+qref-0.1.0.dist-info/METADATA,sha256=HJw29O_7bNlEb8nBpPSotoJCex0xGD5DCS2KFOFiek0,4237
+qref-0.1.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+qref-0.1.0.dist-info/entry_points.txt,sha256=0r4egTAx84xjcp_W-cpOm9kuvc-TQ2DmNMybjcafHRs,78
+qref-0.1.0.dist-info/RECORD,,

qref-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 1.9.0
+Root-Is-Purelib: true
+Tag: py3-none-any

qref-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+qref-render=qref.experimental.rendering:render_entry_point
+