plantgraph 0.1.0__py3-none-any.whl

plantgraph/__init__.py

@@ -0,0 +1,48 @@
+"""plantgraph: the plant context graph schema shared by penguineer and homeostat."""
+
+from importlib.metadata import PackageNotFoundError, version
+
+from plantgraph.model import (
+    EDGE_ENDPOINTS,
+    SCHEMA_VERSION,
+    Actuator,
+    Edge,
+    EdgeType,
+    Equipment,
+    Loop,
+    Node,
+    PlantGraph,
+    Provenance,
+    Quality,
+    SamplePoint,
+    Source,
+    Stream,
+    Tag,
+    Unit,
+    json_schema,
+)
+
+try:
+    __version__ = version("plantgraph")
+except PackageNotFoundError:  # pragma: no cover - running from a source tree
+    __version__ = "0.0.0"
+
+__all__ = [
+    "EDGE_ENDPOINTS",
+    "SCHEMA_VERSION",
+    "Actuator",
+    "Edge",
+    "EdgeType",
+    "Equipment",
+    "Loop",
+    "Node",
+    "PlantGraph",
+    "Provenance",
+    "Quality",
+    "SamplePoint",
+    "Source",
+    "Stream",
+    "Tag",
+    "Unit",
+    "json_schema",
+]

plantgraph/model.py

@@ -0,0 +1,199 @@
+"""Plant context graph: a typed property graph of equipment, streams, tags, loops and qualities.
+
+Every node and edge carries a stable ID, a provenance, a source, a confidence and a
+valid-time interval. The schema depends only on Pydantic so that penguineer and homeostat
+describe a real plant and a simulated one with the same types.
+"""
+
+from __future__ import annotations
+
+from collections.abc import Iterator
+from datetime import date
+from enum import StrEnum
+from typing import Annotated, Literal
+
+from pydantic import BaseModel, ConfigDict, Field
+
+SCHEMA_VERSION = 1
+
+
+class Provenance(StrEnum):
+    declared = "declared"
+    inferred = "inferred"
+    confirmed = "confirmed"
+
+
+class Source(StrEnum):
+    user = "user"
+    llm = "llm"
+    data = "data"
+    dexpi = "dexpi"
+    homeostat = "homeostat"
+
+
+class _Element(BaseModel):
+    model_config = ConfigDict(extra="forbid", populate_by_name=True)
+
+    id: str = Field(min_length=1, description="Stable ID, unique across nodes and edges")
+    provenance: Provenance = Provenance.declared
+    source: Source = Source.user
+    confidence: float = Field(1.0, ge=0.0, le=1.0)
+    valid_from: date | None = None
+    valid_to: date | None = None
+    description: str | None = None
+
+    def valid_on(self, day: date) -> bool:
+        """Whether the element is part of the plant on ``day`` (valid time)."""
+        if self.valid_from is not None and day < self.valid_from:
+            return False
+        return not (self.valid_to is not None and day >= self.valid_to)
+
+
+class Unit(_Element):
+    type: Literal["unit"] = "unit"
+    name: str
+
+
+class Equipment(_Element):
+    type: Literal["equipment"] = "equipment"
+    name: str | None = None
+    kind: str | None = Field(None, description="vessel, exchanger, column, pump, ...")
+    holdup_m3: float | None = Field(None, ge=0, description="Holdup volume in m³, if known")
+
+
+class Stream(_Element):
+    type: Literal["stream"] = "stream"
+    name: str | None = None
+    phase: Literal["liquid", "gas", "solid", "mixed"] | None = None
+
+
+class Tag(_Element):
+    type: Literal["tag"] = "tag"
+    tag: str = Field(description="Historian tag name exactly as it appears in the export")
+    unit_of_measure: str | None = None
+    sample_period_s: float | None = Field(None, gt=0)
+    range_low: float | None = Field(None, description="Instrument range, low end")
+    range_high: float | None = Field(None, description="Instrument range, high end")
+    role: Literal["measurement", "setpoint", "output", "mode", "setting"] | None = Field(
+        None, description="What the signal is; setpoints, modes and settings may sit still"
+    )
+
+
+class Loop(_Element):
+    type: Literal["loop"] = "loop"
+    pv: str | None = Field(None, description="ID of the process value Tag node")
+    sp: str | None = Field(None, description="ID of the setpoint Tag node")
+    op: str | None = Field(None, description="ID of the controller output Tag node")
+    mode: str | None = Field(None, description="ID of the controller mode Tag node")
+
+
+class Actuator(_Element):
+    type: Literal["actuator"] = "actuator"
+    kind: str | None = Field(None, description="valve, drive, ...")
+
+
+class SamplePoint(_Element):
+    type: Literal["sample_point"] = "sample_point"
+    name: str | None = None
+
+
+class Quality(_Element):
+    type: Literal["quality"] = "quality"
+    property: str = Field(description="LIMS property name")
+    spec_low: float | None = None
+    spec_high: float | None = None
+    unit_of_measure: str | None = None
+
+
+AnyNode = Unit | Equipment | Stream | Tag | Loop | Actuator | SamplePoint | Quality
+Node = Annotated[AnyNode, Field(discriminator="type")]
+NodeType = Literal[
+    "unit", "equipment", "stream", "tag", "loop", "actuator", "sample_point", "quality"
+]
+
+
+class EdgeType(StrEnum):
+    flows_to = "flows_to"
+    measures = "measures"
+    controls = "controls"
+    manipulates = "manipulates"
+    samples = "samples"
+    reported_as = "reported_as"
+    affects = "affects"
+
+
+# Allowed (from, to) node types per edge type. ``None`` means any node type.
+EDGE_ENDPOINTS: dict[EdgeType, tuple[frozenset[str] | None, frozenset[str] | None]] = {
+    EdgeType.flows_to: (frozenset({"equipment", "stream"}), frozenset({"equipment", "stream"})),
+    EdgeType.measures: (frozenset({"tag"}), frozenset({"equipment", "stream"})),
+    EdgeType.controls: (frozenset({"loop"}), frozenset({"actuator"})),
+    EdgeType.manipulates: (frozenset({"actuator"}), frozenset({"equipment", "stream"})),
+    EdgeType.samples: (frozenset({"sample_point"}), frozenset({"equipment", "stream"})),
+    EdgeType.reported_as: (frozenset({"sample_point"}), frozenset({"quality"})),
+    EdgeType.affects: (None, None),
+}
+
+
+class Edge(_Element):
+    type: EdgeType
+    from_id: str = Field(alias="from", min_length=1)
+    to_id: str = Field(alias="to", min_length=1)
+    dead_time_min: float | None = Field(None, ge=0, description="flows_to: dead time in minutes")
+    dead_time_low_min: float | None = Field(None, ge=0)
+    dead_time_high_min: float | None = Field(None, ge=0)
+    recycle: bool = Field(False, description="flows_to: edge closes a recycle loop")
+    measured_variable: str | None = Field(None, description="measures: temperature, flow, ...")
+    acting: Literal["direct", "reverse"] | None = Field(None, description="controls")
+
+
+class PlantGraph(BaseModel):
+    """A whole plant graph. Structural rules (dangling IDs, cycles) are checked by tools."""
+
+    model_config = ConfigDict(extra="forbid")
+
+    schema_version: int = SCHEMA_VERSION
+    unit: str | None = Field(None, description="Name of the unit this graph describes")
+    nodes: list[Node] = Field(default_factory=list)
+    edges: list[Edge] = Field(default_factory=list)
+
+    def node(self, node_id: str) -> AnyNode:
+        for n in self.nodes:
+            if n.id == node_id:
+                return n
+        raise KeyError(node_id)
+
+    def nodes_of(self, node_type: NodeType) -> Iterator[AnyNode]:
+        return (n for n in self.nodes if n.type == node_type)
+
+    def edges_of(self, edge_type: EdgeType | str) -> Iterator[Edge]:
+        return (e for e in self.edges if e.type == edge_type)
+
+    def tag_by_name(self) -> dict[str, Tag]:
+        """Tag nodes keyed by historian tag name."""
+        return {n.tag: n for n in self.nodes if isinstance(n, Tag)}
+
+    def valid_on(self, day: date) -> PlantGraph:
+        """The graph as it was valid on ``day``."""
+        return PlantGraph(
+            schema_version=self.schema_version,
+            unit=self.unit,
+            nodes=[n for n in self.nodes if n.valid_on(day)],
+            edges=[e for e in self.edges if e.valid_on(day)],
+        )
+
+    def to_data(self) -> dict:
+        """Plain JSON-compatible dict, with edge endpoints as ``from``/``to``."""
+        data = self.model_dump(mode="json", by_alias=True, exclude_defaults=True)
+        data["schema_version"] = self.schema_version
+        # ``type`` is the discriminator, so it is kept even where it equals the default.
+        for key, elements in (("nodes", self.nodes), ("edges", self.edges)):
+            data[key] = [
+                {"id": el.id, "type": str(el.type), **{k: v for k, v in d.items() if k != "id"}}
+                for el, d in zip(elements, data.get(key, []), strict=True)
+            ]
+        return data
+
+
+def json_schema() -> dict:
+    """JSON Schema of :class:`PlantGraph`, for editors and other languages."""
+    return PlantGraph.model_json_schema(by_alias=True)

plantgraph-0.1.0.dist-info/METADATA

@@ -0,0 +1,32 @@
+Metadata-Version: 2.5
+Name: plantgraph
+Version: 0.1.0
+Summary: Typed plant context graph schema shared by penguineer and homeostat
+Project-URL: Documentation, https://kausalflow.com/penguineer/concepts/plant-graph/
+Project-URL: Source, https://github.com/kausalflow/penguineer/tree/main/packages/plantgraph
+Author: KausalFlow
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: plant graph,process industry,pydantic
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.11
+Requires-Dist: pydantic>=2.7
+Description-Content-Type: text/markdown
+
+# plantgraph
+
+The plant context graph schema used by [penguineer](https://github.com/kausalflow/penguineer) and homeostat. It depends only on Pydantic.
+
+A graph has typed nodes (`unit`, `equipment`, `stream`, `tag`, `loop`, `actuator`, `sample_point`, `quality`) and typed edges (`flows_to`, `measures`, `controls`, `manipulates`, `samples`, `reported_as`, `affects`). Every node and edge carries a stable `id`, a `provenance` (declared, inferred or confirmed), a `source` (user, llm, data, dexpi or homeostat), a `confidence` and `valid_from` / `valid_to` dates.
+
+```python
+from plantgraph import PlantGraph
+
+graph = PlantGraph.model_validate(data)  # data loaded from YAML or JSON
+graph.valid_on(date(2026, 8, 3))  # the plant as it was on that day
+graph.to_data()  # back to a plain dict
+```
+
+Licensed under Apache-2.0.

plantgraph-0.1.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+plantgraph/__init__.py,sha256=KtjfCET1znJwPvl8auhWP-U5UsG_QIKx3dkkJNozg3U,850
+plantgraph/model.py,sha256=yLw_TbbLKQ4GtEG5_S8znBWSOwdBM0E9OG7D0_CIaLE,7453
+plantgraph-0.1.0.dist-info/METADATA,sha256=wEOzZPKmalNjcRQgw032Duxj2_Zee2XBy58JiJwyKEI,1480
+plantgraph-0.1.0.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+plantgraph-0.1.0.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+plantgraph-0.1.0.dist-info/RECORD,,

plantgraph-0.1.0.dist-info/WHEEL

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

plantgraph-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.