api581-engine 0.1.4__py3-none-any.whl

api581/data/digital-twin.schema.json

@@ -0,0 +1,538 @@
+{
+  "TwinMeasurement": {
+    "additionalProperties": false,
+    "properties": {
+      "measurement_id": {
+        "maxLength": 200,
+        "minLength": 1,
+        "title": "Measurement Id",
+        "type": "string"
+      },
+      "quantity": {
+        "maxLength": 200,
+        "minLength": 1,
+        "title": "Quantity",
+        "type": "string"
+      },
+      "value": {
+        "title": "Value",
+        "type": "number"
+      },
+      "unit": {
+        "maxLength": 50,
+        "minLength": 1,
+        "title": "Unit",
+        "type": "string"
+      },
+      "measured_at": {
+        "format": "date-time",
+        "title": "Measured At",
+        "type": "string"
+      },
+      "source": {
+        "maxLength": 500,
+        "minLength": 1,
+        "title": "Source",
+        "type": "string"
+      },
+      "quality": {
+        "enum": [
+          "measured",
+          "estimated",
+          "simulated"
+        ],
+        "title": "Quality",
+        "type": "string"
+      },
+      "uncertainty": {
+        "anyOf": [
+          {
+            "minimum": 0,
+            "type": "number"
+          },
+          {
+            "type": "null"
+          }
+        ],
+        "default": null,
+        "title": "Uncertainty"
+      }
+    },
+    "required": [
+      "measurement_id",
+      "quantity",
+      "value",
+      "unit",
+      "measured_at",
+      "source",
+      "quality"
+    ],
+    "title": "TwinMeasurement",
+    "type": "object"
+  },
+  "TwinCalculationRequest": {
+    "$defs": {
+      "TwinMeasurement": {
+        "additionalProperties": false,
+        "properties": {
+          "measurement_id": {
+            "maxLength": 200,
+            "minLength": 1,
+            "title": "Measurement Id",
+            "type": "string"
+          },
+          "quantity": {
+            "maxLength": 200,
+            "minLength": 1,
+            "title": "Quantity",
+            "type": "string"
+          },
+          "value": {
+            "title": "Value",
+            "type": "number"
+          },
+          "unit": {
+            "maxLength": 50,
+            "minLength": 1,
+            "title": "Unit",
+            "type": "string"
+          },
+          "measured_at": {
+            "format": "date-time",
+            "title": "Measured At",
+            "type": "string"
+          },
+          "source": {
+            "maxLength": 500,
+            "minLength": 1,
+            "title": "Source",
+            "type": "string"
+          },
+          "quality": {
+            "enum": [
+              "measured",
+              "estimated",
+              "simulated"
+            ],
+            "title": "Quality",
+            "type": "string"
+          },
+          "uncertainty": {
+            "anyOf": [
+              {
+                "minimum": 0,
+                "type": "number"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "default": null,
+            "title": "Uncertainty"
+          }
+        },
+        "required": [
+          "measurement_id",
+          "quantity",
+          "value",
+          "unit",
+          "measured_at",
+          "source",
+          "quality"
+        ],
+        "title": "TwinMeasurement",
+        "type": "object"
+      }
+    },
+    "additionalProperties": false,
+    "description": "Immutable calculation request envelope supplied by a twin host.",
+    "properties": {
+      "request_id": {
+        "maxLength": 200,
+        "minLength": 1,
+        "title": "Request Id",
+        "type": "string"
+      },
+      "calculation_id": {
+        "maxLength": 200,
+        "minLength": 1,
+        "title": "Calculation Id",
+        "type": "string"
+      },
+      "asset_id": {
+        "maxLength": 200,
+        "minLength": 1,
+        "title": "Asset Id",
+        "type": "string"
+      },
+      "component_id": {
+        "maxLength": 200,
+        "minLength": 1,
+        "title": "Component Id",
+        "type": "string"
+      },
+      "observed_at": {
+        "format": "date-time",
+        "title": "Observed At",
+        "type": "string"
+      },
+      "source_revision": {
+        "maxLength": 200,
+        "minLength": 1,
+        "title": "Source Revision",
+        "type": "string"
+      },
+      "correlation_id": {
+        "maxLength": 200,
+        "minLength": 1,
+        "title": "Correlation Id",
+        "type": "string"
+      },
+      "inputs": {
+        "additionalProperties": true,
+        "title": "Inputs",
+        "type": "object"
+      },
+      "measurements": {
+        "items": {
+          "$ref": "#/$defs/TwinMeasurement"
+        },
+        "maxItems": 10000,
+        "title": "Measurements",
+        "type": "array"
+      },
+      "contract_version": {
+        "const": "api581-twin-1",
+        "default": "api581-twin-1",
+        "title": "Contract Version",
+        "type": "string"
+      }
+    },
+    "required": [
+      "request_id",
+      "calculation_id",
+      "asset_id",
+      "component_id",
+      "observed_at",
+      "source_revision",
+      "correlation_id",
+      "inputs"
+    ],
+    "title": "TwinCalculationRequest",
+    "type": "object"
+  },
+  "TwinCalculationResponse": {
+    "$defs": {
+      "ValidationEvidence": {
+        "additionalProperties": false,
+        "description": "Stable JSON shape linking a calculation to its verification record.",
+        "properties": {
+          "manifest": {
+            "title": "Manifest",
+            "type": "string"
+          },
+          "packaged_manifest": {
+            "title": "Packaged Manifest",
+            "type": "string"
+          },
+          "verification_scripts": {
+            "items": {
+              "type": "string"
+            },
+            "title": "Verification Scripts",
+            "type": "array"
+          }
+        },
+        "required": [
+          "manifest",
+          "packaged_manifest",
+          "verification_scripts"
+        ],
+        "title": "ValidationEvidence",
+        "type": "object"
+      }
+    },
+    "additionalProperties": false,
+    "description": "Reproducible result envelope returned to a twin host.",
+    "properties": {
+      "contract_version": {
+        "const": "api581-twin-1",
+        "default": "api581-twin-1",
+        "title": "Contract Version",
+        "type": "string"
+      },
+      "request_id": {
+        "maxLength": 200,
+        "minLength": 1,
+        "title": "Request Id",
+        "type": "string"
+      },
+      "run_id": {
+        "maxLength": 200,
+        "minLength": 1,
+        "title": "Run Id",
+        "type": "string"
+      },
+      "calculation_id": {
+        "maxLength": 200,
+        "minLength": 1,
+        "title": "Calculation Id",
+        "type": "string"
+      },
+      "asset_id": {
+        "maxLength": 200,
+        "minLength": 1,
+        "title": "Asset Id",
+        "type": "string"
+      },
+      "component_id": {
+        "maxLength": 200,
+        "minLength": 1,
+        "title": "Component Id",
+        "type": "string"
+      },
+      "observed_at": {
+        "format": "date-time",
+        "title": "Observed At",
+        "type": "string"
+      },
+      "input_hash": {
+        "maxLength": 200,
+        "minLength": 1,
+        "title": "Input Hash",
+        "type": "string"
+      },
+      "engine_version": {
+        "maxLength": 100,
+        "minLength": 1,
+        "title": "Engine Version",
+        "type": "string"
+      },
+      "standard_edition": {
+        "maxLength": 100,
+        "minLength": 1,
+        "title": "Standard Edition",
+        "type": "string"
+      },
+      "code_fingerprint": {
+        "maxLength": 200,
+        "minLength": 1,
+        "title": "Code Fingerprint",
+        "type": "string"
+      },
+      "outputs": {
+        "additionalProperties": true,
+        "title": "Outputs",
+        "type": "object"
+      },
+      "references": {
+        "items": {
+          "type": "string"
+        },
+        "title": "References",
+        "type": "array"
+      },
+      "limitations": {
+        "items": {
+          "type": "string"
+        },
+        "title": "Limitations",
+        "type": "array"
+      },
+      "validation_evidence": {
+        "items": {
+          "$ref": "#/$defs/ValidationEvidence"
+        },
+        "title": "Validation Evidence",
+        "type": "array"
+      },
+      "software_test_modules": {
+        "items": {
+          "type": "string"
+        },
+        "title": "Software Test Modules",
+        "type": "array"
+      },
+      "direct_public_test_modules": {
+        "items": {
+          "type": "string"
+        },
+        "title": "Direct Public Test Modules",
+        "type": "array"
+      },
+      "validation_level": {
+        "default": "software_tested_only",
+        "enum": [
+          "software_tested_only",
+          "native_engine_fixture_verified"
+        ],
+        "title": "Validation Level",
+        "type": "string"
+      },
+      "validation_status": {
+        "maxLength": 200,
+        "minLength": 1,
+        "title": "Validation Status",
+        "type": "string"
+      }
+    },
+    "required": [
+      "request_id",
+      "run_id",
+      "calculation_id",
+      "asset_id",
+      "component_id",
+      "observed_at",
+      "input_hash",
+      "engine_version",
+      "standard_edition",
+      "code_fingerprint",
+      "outputs",
+      "references",
+      "limitations",
+      "validation_status"
+    ],
+    "title": "TwinCalculationResponse",
+    "type": "object"
+  },
+  "TwinBatchShard": {
+    "additionalProperties": false,
+    "description": "Deterministic work partition that a host may submit to an HPC queue.",
+    "properties": {
+      "shard_id": {
+        "maxLength": 200,
+        "minLength": 1,
+        "title": "Shard Id",
+        "type": "string"
+      },
+      "ordinal": {
+        "minimum": 0,
+        "title": "Ordinal",
+        "type": "integer"
+      },
+      "request_ids": {
+        "items": {
+          "type": "string"
+        },
+        "maxItems": 100000,
+        "minItems": 1,
+        "title": "Request Ids",
+        "type": "array"
+      },
+      "payload_hash": {
+        "maxLength": 64,
+        "minLength": 64,
+        "title": "Payload Hash",
+        "type": "string"
+      }
+    },
+    "required": [
+      "shard_id",
+      "ordinal",
+      "request_ids",
+      "payload_hash"
+    ],
+    "title": "TwinBatchShard",
+    "type": "object"
+  },
+  "TwinBatchPlan": {
+    "$defs": {
+      "TwinBatchShard": {
+        "additionalProperties": false,
+        "description": "Deterministic work partition that a host may submit to an HPC queue.",
+        "properties": {
+          "shard_id": {
+            "maxLength": 200,
+            "minLength": 1,
+            "title": "Shard Id",
+            "type": "string"
+          },
+          "ordinal": {
+            "minimum": 0,
+            "title": "Ordinal",
+            "type": "integer"
+          },
+          "request_ids": {
+            "items": {
+              "type": "string"
+            },
+            "maxItems": 100000,
+            "minItems": 1,
+            "title": "Request Ids",
+            "type": "array"
+          },
+          "payload_hash": {
+            "maxLength": 64,
+            "minLength": 64,
+            "title": "Payload Hash",
+            "type": "string"
+          }
+        },
+        "required": [
+          "shard_id",
+          "ordinal",
+          "request_ids",
+          "payload_hash"
+        ],
+        "title": "TwinBatchShard",
+        "type": "object"
+      }
+    },
+    "additionalProperties": false,
+    "description": "Scheduler-neutral manifest for replayable digital-twin batches.",
+    "properties": {
+      "contract_version": {
+        "const": "api581-batch-1",
+        "default": "api581-batch-1",
+        "title": "Contract Version",
+        "type": "string"
+      },
+      "batch_id": {
+        "maxLength": 200,
+        "minLength": 1,
+        "title": "Batch Id",
+        "type": "string"
+      },
+      "request_count": {
+        "minimum": 0,
+        "title": "Request Count",
+        "type": "integer"
+      },
+      "shard_size": {
+        "exclusiveMinimum": 0,
+        "title": "Shard Size",
+        "type": "integer"
+      },
+      "request_ids": {
+        "items": {
+          "type": "string"
+        },
+        "title": "Request Ids",
+        "type": "array"
+      },
+      "shards": {
+        "items": {
+          "$ref": "#/$defs/TwinBatchShard"
+        },
+        "title": "Shards",
+        "type": "array"
+      },
+      "plan_hash": {
+        "maxLength": 64,
+        "minLength": 64,
+        "title": "Plan Hash",
+        "type": "string"
+      }
+    },
+    "required": [
+      "batch_id",
+      "request_count",
+      "shard_size",
+      "request_ids",
+      "shards",
+      "plan_hash"
+    ],
+    "title": "TwinBatchPlan",
+    "type": "object"
+  }
+}

api581/data/direct-test-queue.json

@@ -0,0 +1,7 @@
+{
+  "description": "Calculations lacking a direct numeric/branch test-module reference; registry contracts remain separate evidence.",
+  "calculation_count": 509,
+  "direct_test_gap_count": 0,
+  "domain_counts": {},
+  "calculations": []
+}

api581/data/native-engine-evidence.json

@@ -0,0 +1,44 @@
+{
+  "standard_edition": "API-RP-581-2016-3rd-base",
+  "verification_date": "2026-10-25",
+  "environment": {
+    "slabx": "1.0.8",
+    "slabx-lh2": "0.2.0",
+    "CoolProp": "8.0.0",
+    "numpy": "2.5.3",
+    "scipy": "1.18.1"
+  },
+  "engine_source_fingerprints": {
+    "slabx": "cce58647c6f3d741ef125a790032d521f09ebd636f1b4a9188e89f8a812fae8a",
+    "slabx-lh2": "a7e27d03ae1f145acf779c07d2e6dbae9e99e8c73f77e690c25c0c6098fb0dd4"
+  },
+  "runs": {
+    "verify_native_dispersion.py": {
+      "status": "passed",
+      "checks": ["native_direct_exact_array_equivalence", "kg_kmol_and_humidity_unit_mapping", "boundary_censoring", "no_exceedance_nan_to_null", "lh2_native_execution", "lh2_premise_violation_blocks_distance", "concurrent_process_isolation_and_repeatability", "host_module_globals_unchanged"]
+    },
+    "verify_native_jet.py": {
+      "status": "passed",
+      "checks": ["horizontal_native_exact_arrays", "vertical_native_exact_arrays", "native_exit_velocity", "jet_at_y_exact_field", "source_handoff_boundary_censoring", "explicit_temperature_clamp", "buoyant_vertical_native_exact_arrays", "lh2_horizontal_native_run", "partition_to_native_exact_chain", "partitioned_planar_run"]
+    },
+    "verify_native_footprint.py": {
+      "status": "passed",
+      "checks": ["native_at_y_exact_field_equivalence", "crosswind_symmetry", "crosswind_grid_refinement", "lateral_censoring", "censored_flash_bridge_rejection", "native_flash_quarter_area_mapping", "lh2_planar_execution", "lh2_premise_blocks_area"]
+    },
+    "verify_native_toxic.py": {
+      "status": "passed",
+      "checks": ["historical_probit50_ppm_anchor", "direct_native_centreline_exact", "direct_native_planar_exact", "exposure_average_and_release_window_mapping", "independent_native_area_chain", "nonignition_probability_once", "toxic_equipment_zero", "censored_area_rejected", "short_source_window_rejected"]
+    },
+    "verify_native_saturation.py": {"status": "passed", "scope": "pure-fluid saturation, pressure-temperature round trip, Clapeyron identity and pool guards"},
+    "verify_native_flash.py": {"status": "passed", "scope": "native flash methods, phase endpoints, composition basis and typed partition closure"},
+    "verify_native_flash_pool.py": {"status": "passed", "scope": "EOS/partition/steady-pool/native chain and LH2 premise reporting"},
+    "verify_native_flashed_pool_footprint.py": {"status": "passed", "scope": "EOS-to-footprint/fire area mapping, grid refinement and censored consequence rejection"},
+    "verify_native_flashed_pool_risk.py": {"status": "passed", "scope": "GFF/Fms/DF/event-weather weighting and raw-area preservation"}
+  },
+  "limitations": [
+    "These are software integration and fixture checks, not API 581 conformity certification.",
+    "Native source domains, site applicability, fluid properties, thresholds and exposure assumptions remain caller-qualified.",
+    "A passing LH2 premise check is not experimental or field validation.",
+    "The evidence is tied to the listed package versions and source fingerprints."
+  ]
+}