os-optics 0.10.0__py3-none-any.whl

os_optics/__init__.py

@@ -0,0 +1,65 @@
+"""OS Optics (``os_optics``) by OpenSci: deterministic, stateless, offline 3D optical / layout / control engineering engine.
+
+Pure-optical design on this device (public optical catalog -> Project -> simulation -> local validation record)::
+
+    from os_optics.local import example_project, load_public_catalog, run_optical_project
+    run = run_optical_project(example_project())
+
+See ``help(os_optics.local)``. The scientific results of a run directory (monitors, beams, rays, wavefronts, power
+budget, exports): ``help(os_optics.results)``. Low-level Engine use::
+
+    from os_optics import ValidationRequest, validate
+    result = validate(ValidationRequest(project=...))
+"""
+
+import sys as _sys
+
+from ._version import MIN_PYTHON as _MIN_PYTHON
+
+if _sys.version_info < _MIN_PYTHON:
+    raise ImportError(
+        "os-optics needs Python {0}.{1} or newer; this interpreter is Python {2} ({3}). Install it with a supported "
+        "Python: 'uv tool install \"os-optics[protected]\"' (uv selects or downloads a compatible Python), or create "
+        "a virtual environment from Python {0}.{1}+ and run 'python -m pip install \"os-optics[protected]\"' in it."
+        .format(*_MIN_PYTHON, ".".join(str(p) for p in _sys.version_info[:3]), _sys.executable)
+    )
+
+from ._version import ENGINE_VERSION, MODEL_VERSIONS, NUMERICAL_CONFIG_VERSION, SCHEMA_VERSION, __version__
+from .config import DEFAULT_NUMERICAL_CONFIG, NumericalConfig
+from .contracts.request import EngineConfiguration, ValidationRequest
+from .contracts.results import ValidationResult
+from .errors import ErrorCode, Status, ValidationIssue
+from .validation import (
+    RAY_PATHS_VERSION,
+    PupilRayPath,
+    RayPath,
+    RayPathTrace,
+    trace_ray_paths,
+    validate,
+    validate_json,
+    validate_with_ray_paths,
+)
+
+__all__ = [
+    "__version__",
+    "ENGINE_VERSION",
+    "SCHEMA_VERSION",
+    "NUMERICAL_CONFIG_VERSION",
+    "MODEL_VERSIONS",
+    "NumericalConfig",
+    "DEFAULT_NUMERICAL_CONFIG",
+    "EngineConfiguration",
+    "ValidationRequest",
+    "ValidationResult",
+    "ValidationIssue",
+    "ErrorCode",
+    "Status",
+    "validate",
+    "validate_json",
+    "validate_with_ray_paths",
+    "trace_ray_paths",
+    "RAY_PATHS_VERSION",
+    "PupilRayPath",
+    "RayPath",
+    "RayPathTrace",
+]

os_optics/__main__.py

@@ -0,0 +1,3 @@
+from .cli import main
+
+raise SystemExit(main())

os_optics/_vendor/MANIFEST.json

@@ -0,0 +1,154 @@
+{
+  "files": {
+    "shared_contracts/assembly_detail/__init__.py": {
+      "sha256": "f25c27b6af1a786f2d91cea35484b9502ecaa7470a21eac186460475b0ddf3dc"
+    },
+    "shared_contracts/assembly_detail/detail.py": {
+      "sha256": "43b4fdadd739027a6d8e4fcfbeca527212dc564f22e657392f88760a81f6844d"
+    },
+    "shared_contracts/assembly_detail/drawing.py": {
+      "sha256": "14336e6b2659cf0d0195c9038d613a09f89bd0fe75a4641bcb60d61243a137e2"
+    },
+    "shared_contracts/assembly_detail/verify.py": {
+      "sha256": "b2677520ecaa6b91bb98995c1ef13cbc39fb15574a4ced2b80c927ea1be28ef8"
+    },
+    "shared_contracts/assembly_preview/__init__.py": {
+      "sha256": "e399a7b316a13e8f06408c3b73441584d57c918b6489ed2bed6d1710038c22ad"
+    },
+    "shared_contracts/assembly_preview/manifest.py": {
+      "sha256": "f8463be37d1a31f8ce5258b9b91620dfdc88266452318fc0c28956c023e62c65"
+    },
+    "shared_contracts/assembly_preview/package.py": {
+      "sha256": "54ac77fb60e330999549dac8761edb014238fb068204712a455175294ac77867"
+    },
+    "shared_contracts/assembly_preview/scene.py": {
+      "sha256": "fddef5c34c7c52e4f729fe42a0e9ed7d19d4bbfba86b67cf430e1dabc7898289"
+    },
+    "shared_contracts/assembly_preview/validation.py": {
+      "sha256": "31b45137972dc70c16cc6e0fa31b5a241adc6371eada6256086f510dc0a98282"
+    },
+    "shared_contracts/base.py": {
+      "sha256": "91872f403ab5bd60e191aba9c678da3cff959510be96b83751ec4ded17b9fd15"
+    },
+    "shared_contracts/client_assembly_artifact/__init__.py": {
+      "sha256": "38a80f528f6cc1f259a6fbc35a0b16e3f883e3dc6625674563236d60fce3d877"
+    },
+    "shared_contracts/client_assembly_artifact/manifest.py": {
+      "sha256": "8da2304945abecddc3d79a1ffeeb4582e05468a7a3b2f4012099f0db36ca632e"
+    },
+    "shared_contracts/common/__init__.py": {
+      "sha256": "ddf352172fd402fbd7630f8558f09d070d8d93de5c78b024d3aeacc47d6a886c"
+    },
+    "shared_contracts/common/_osc1_numbers.py": {
+      "sha256": "6f1d260101f53286fed7e22c0202fd37145284c487811acabc4229522db43ce1"
+    },
+    "shared_contracts/common/decimal_string.py": {
+      "sha256": "349918de473485480ef009d9e446e3f9f689995c83475f11ed4c86be8e1614ab"
+    },
+    "shared_contracts/common/frozen_string_map.py": {
+      "sha256": "8c5deee99ef308793f619b49673f2dc7341bf54afa42bf5fc0f748f548d11aa0"
+    },
+    "shared_contracts/common/geometry.py": {
+      "sha256": "95780ad905fde84049aa62ec3deb0da2f28b3a62f4e3ff9cfb3484b1ff4df1eb"
+    },
+    "shared_contracts/common/hashes.py": {
+      "sha256": "3113f9bea2ba9148f83fd9ceba5a0605d2c549c99113ded0fa502c14f3cf53bf"
+    },
+    "shared_contracts/common/identifiers.py": {
+      "sha256": "019d1a4c16116375dd6ce5fb18af91d1a0572ec6b68b12be89a48a049980bc9a"
+    },
+    "shared_contracts/common/ordering.py": {
+      "sha256": "65016689504d009e32fa420dae9ba8d5107b90bf04d639128469e7e224c45253"
+    },
+    "shared_contracts/common/osc1.py": {
+      "sha256": "ea62eb3b63edb8d9d5aa45f3da1de2a1b0492abe03406f15605e4d4f2e438b08"
+    },
+    "shared_contracts/common/safe_int.py": {
+      "sha256": "daf26aec847b09265af7bc37ffaa8e859edfff584e794a5654e6261519f18392"
+    },
+    "shared_contracts/common/timestamps.py": {
+      "sha256": "f33b597a04c7d44e247b8bc13712990d35c7168f6077d9d220f457bb03498db9"
+    },
+    "shared_contracts/common/unknown.py": {
+      "sha256": "a76d5622de9eba483702d1479de682dd9bece6ce3da783205a12a7a731fd1fb5"
+    },
+    "shared_contracts/common/versioning.py": {
+      "sha256": "8c039e5d0176784a4e9e4884688fe1a9446c22b04d79f4a3d2a23cb9b13da35c"
+    },
+    "shared_contracts/design_catalog/__init__.py": {
+      "sha256": "9efa0a0f409d717e728bbe0a993fea70214a699ff64b5c1a62a40f3d5f5624e3"
+    },
+    "shared_contracts/design_catalog/enums.py": {
+      "sha256": "138bfd02ecd14e3d42e00d0c360c66b404cc7544ea56c9d5b7a6d5c19b6ef271"
+    },
+    "shared_contracts/design_catalog/manifest.py": {
+      "sha256": "30aaf7a965e5d9292fedde6a246eed6d24ac41f91dc3566a62a242a34915dfbe"
+    },
+    "shared_contracts/design_catalog/optical_catalog.py": {
+      "sha256": "12596468fec693537990727cd097b3e4562a2c845495a26db64a26798f04fe4e"
+    },
+    "shared_contracts/optical_design/__init__.py": {
+      "sha256": "20944c36a75eefe533612334c87d14dd44938dd55a1f0d995bdf954e4062d925"
+    },
+    "shared_contracts/optical_design/_ordering.py": {
+      "sha256": "0c9e65e49056379b3fc5d74f1a18e2db987fe8a3bb3368c747730c9c120ebc8e"
+    },
+    "shared_contracts/optical_design/component.py": {
+      "sha256": "489621d8ac3bc76dc32701c11b2dfdb63ee38bf658a1cc6a666ea8239be517e7"
+    },
+    "shared_contracts/optical_design/compute_budget.py": {
+      "sha256": "e5fc941b045dd906f3a505da99de3aa71eb998cc6c53fd714512c69e1c94b233"
+    },
+    "shared_contracts/optical_design/design_content.py": {
+      "sha256": "bc16d05be05e04493ff26e0bc7e4fe0d25fb5682a8ce41ad473d39575798b588"
+    },
+    "shared_contracts/optical_design/dof.py": {
+      "sha256": "72ae9024ce6e2ff32182b2707ac597dd27fd08300986434868479e7349089fe2"
+    },
+    "shared_contracts/optical_design/local_validation.py": {
+      "sha256": "589c9b51273dddee7fccda3006eaac136b846eaa44de489e4aed92278c1e30e7"
+    },
+    "shared_contracts/optical_design/optical_model.py": {
+      "sha256": "e4fa8d3b6668b9244bc2c974d66541e51c0b133fa3ed7d1d848ae28ff9394676"
+    },
+    "shared_contracts/optical_design/project.py": {
+      "sha256": "8bb6415af8ba9bc474aa79c3cd92bf68e9e40859b58f2056d043ebaecf571ba4"
+    },
+    "shared_contracts/optical_design/scientific_result.py": {
+      "sha256": "d3cb284eda3099aaf55f4e0787bd5bca6f6bd8f0c1d3288d3675e30555b8c3fd"
+    },
+    "shared_contracts/optical_design/source.py": {
+      "sha256": "a771353876db440dba3821a162a7e888ca13b1dec80c8449f160c8f03c0e0448"
+    },
+    "shared_contracts/optical_design/workspace.py": {
+      "sha256": "4f4f0e51dc9684777d18688a4b733528b3b37ed62c14e6fb1fabf3d05711b851"
+    },
+    "shared_contracts/optical_layout/__init__.py": {
+      "sha256": "185df9517389e6a5d2f19cd6d09af7f2c56029ce90bce89ab31920469a5cd0fb"
+    },
+    "shared_contracts/optical_layout/drawing.py": {
+      "sha256": "5002aa975675ce7a112c542690982a24dbddad4befedf2c916c53ea57c462997"
+    },
+    "shared_contracts/optical_layout/package.py": {
+      "sha256": "23c969fc10be518f7a581c574b9ab0e353f79d74360c60f495ebeee3de0e575e"
+    },
+    "shared_contracts/optical_view/__init__.py": {
+      "sha256": "a45aa3c22f5fd0a5761a2154dfe7f1b1f051926aaebd008dd7085b9471e24dbb"
+    },
+    "shared_contracts/optical_view/scene.py": {
+      "sha256": "f321cad56ab338c481d85b3abd36e8034c2a94bff3a97101d34f42dab73469e3"
+    },
+    "shared_contracts/protected_assembly_delivery/__init__.py": {
+      "sha256": "c51696f2936339942dce4cde33914626f91a88c6abe556203b01dac76bae6f98"
+    },
+    "shared_contracts/protected_assembly_delivery/_common.py": {
+      "sha256": "920c4f9c594d79cf5f5f28d8763c8559c9abecea1053f96218ddc8f77efc92f4"
+    },
+    "shared_contracts/protected_assembly_delivery/detail_envelope.py": {
+      "sha256": "8551e8581f32900fef4d88750732379244ee3a2657263d93b742bfed3860c8b9"
+    },
+    "shared_contracts/protected_assembly_delivery/envelope.py": {
+      "sha256": "30b0bc148248e7620122bb074493e239ed8fd4a965b2dcb950491bbd379183d0"
+    }
+  }
+}

os_optics/_vendor/__init__.py

@@ -0,0 +1,16 @@
+"""OpenSci contracts bundled with os-optics (generated; do not edit).
+
+``shared_contracts/`` holds the contract models the local workflow reads, writes and verifies: the pure-optical Project
+and its Local Validation record (``optical_design``), the public optical catalog and its release manifest
+(``design_catalog``), the Optical Simulation View scene (``optical_view``), the Assembly Preview Package and its local
+validation result (``assembly_preview``), the Assembly Detail Package and the local Detailed Assembly Drawing outputs
+(``assembly_detail``), the protected delivery envelope and decryption grant a client opens in memory
+(``protected_assembly_delivery``), the manifest of a client-generated artifact upload (``client_assembly_artifact``) and
+the Optical Layout Package of an optics-only purchase with its local drawing manifest (``optical_layout``), together
+with the common modules they use. ``MANIFEST.json`` lists the SHA-256 of every contract module except the two
+generated package ``__init__`` files. The public optical catalog itself is versioned data kept in a local catalog store
+(``os_optics.catalog``), not part of this package.
+
+This package is an implementation detail: use ``os_optics.local``, ``os_optics.protected_delivery`` and
+``os_optics.client_artifacts`` rather than importing from here.
+"""

os_optics/_vendor/shared_contracts/__init__.py

@@ -0,0 +1,9 @@
+"""OpenSci contract families bundled with os-optics (generated; do not edit).
+
+Present: the pure-optical design contracts (``optical_design``), the public optical catalog contract
+(``design_catalog``), the Optical Simulation View scene contract (``optical_view``), the Assembly Preview Package
+contract (``assembly_preview``), the Assembly Detail Package and local drawing output contract (``assembly_detail``),
+the protected delivery contract a client opens (``protected_assembly_delivery``; ``cryptography`` is imported lazily,
+only for the AES-GCM step), the client artifact upload manifest (``client_assembly_artifact``), the Optical Layout
+Package and its local drawing manifest (``optical_layout``) and the modules they import. Nothing is re-exported here.
+"""

os_optics/_vendor/shared_contracts/assembly_detail/__init__.py

@@ -0,0 +1,164 @@
+"""Assembly Detail Package and local Detailed Assembly Drawing outputs.
+
+* ``detail`` -- ``AssemblyDetailPackageV1``: the dimensioning supplement of exactly one verified Assembly Preview
+  Package. It adds only what the preview cannot supply deterministically -- assembly dimension references between
+  scene points with their basis -- plus binding, release and usage terms. It repeats no pose, identity, mate,
+  setting, fixation, breadboard or geometry of the preview;
+* ``verify`` -- canonical bytes, ``build_assembly_detail`` (binding copied from the preview manifest) and
+  ``verify_assembly_detail`` / ``load_assembly_detail`` against the verified preview package, with every dimension
+  measured from the preview's own poses;
+* ``drawing`` -- ``AssemblyDrawingResultV1`` and ``AssemblyDrawingManifestV1``: what a local runtime's generated
+  drawing shows, and the local output manifest (SVG, PDF, result) that an artifact upload carries.
+"""
+
+from .detail import (
+    ASSEMBLY_DETAIL_FILE_NAME,
+    ASSEMBLY_DETAIL_MEDIA_TYPE,
+    ASSEMBLY_DETAIL_SCHEMA_ID,
+    ASSEMBLY_DETAIL_SCHEMA_VERSION,
+    AXIS_INDEX,
+    DETAIL_PERMITTED_USES,
+    DETAIL_USAGE_STATEMENT,
+    MAX_DETAIL_BYTES,
+    MAX_DIMENSIONS,
+    AssemblyDetailPackageV1,
+    CustomerFacingName,
+    CustomerSuppliedModelV1,
+    DetailBindingV1,
+    DetailReleaseRefV1,
+    DetailUsageTermsV1,
+    DimensionBasisV1,
+    DimensionKindV1,
+    DimensionV1,
+    MeasureAxisV1,
+    PointKindV1,
+    PointRefV1,
+    ReleaseBasisV1,
+    SettingRefV1,
+    detail_content_hash_of,
+)
+from .drawing import (
+    ASSEMBLY_DRAWING_GENERATOR_ID,
+    ASSEMBLY_DRAWING_MANIFEST_SCHEMA_ID,
+    ASSEMBLY_DRAWING_RESULT_SCHEMA_ID,
+    ASSEMBLY_DRAWING_SCHEMA_VERSION,
+    DRAWING_MANIFEST_PATH,
+    DRAWING_DESCRIPTION,
+    DRAWING_LOCALES,
+    DRAWING_PDF_PATH,
+    DRAWING_RESULT_PATH,
+    DRAWING_SVG_PATH,
+    JSON_MEDIA_TYPE,
+    LEGACY_DRAWING_ROLE_ALIASES,
+    PDF_MEDIA_TYPE,
+    SVG_MEDIA_TYPE,
+    AssemblyDrawingManifestV1,
+    AssemblyDrawingResultV1,
+    AssemblyStepV1,
+    CustomerSuppliedRowV1,
+    DrawingBalloonV1,
+    DrawingBindingV1,
+    DrawingDimensionV1,
+    DrawingFileRoleV1,
+    DrawingGeneratorRefV1,
+    DrawingLocaleV1,
+    DrawingOutputFileV1,
+    DrawingSheetV1,
+    DrawingStatusV1,
+    DrawingValidationRefV1,
+    DrawingViewKindV1,
+    DrawingViewV1,
+    OpticalSpacingRowV1,
+    PartsLegendRowV1,
+    PartsLegendV1,
+    StepActionV1,
+    drawing_manifest_for,
+    verify_drawing_outputs,
+)
+from .verify import (
+    ALLOWED_BASES,
+    MEASURE_TOLERANCE_MM,
+    AssemblyDetailPackageError,
+    MeasuredDimensionV1,
+    VerifiedAssemblyDetailV1,
+    build_assembly_detail,
+    detail_file_bytes,
+    load_assembly_detail,
+    measure,
+    point_in_world,
+    verify_assembly_detail,
+)
+
+__all__ = [
+    "ALLOWED_BASES",
+    "ASSEMBLY_DETAIL_FILE_NAME",
+    "ASSEMBLY_DETAIL_MEDIA_TYPE",
+    "ASSEMBLY_DETAIL_SCHEMA_ID",
+    "ASSEMBLY_DETAIL_SCHEMA_VERSION",
+    "ASSEMBLY_DRAWING_GENERATOR_ID",
+    "ASSEMBLY_DRAWING_MANIFEST_SCHEMA_ID",
+    "ASSEMBLY_DRAWING_RESULT_SCHEMA_ID",
+    "ASSEMBLY_DRAWING_SCHEMA_VERSION",
+    "AXIS_INDEX",
+    "DETAIL_PERMITTED_USES",
+    "DETAIL_USAGE_STATEMENT",
+    "DRAWING_MANIFEST_PATH",
+    "DRAWING_DESCRIPTION",
+    "DRAWING_LOCALES",
+    "DRAWING_PDF_PATH",
+    "DRAWING_RESULT_PATH",
+    "DRAWING_SVG_PATH",
+    "JSON_MEDIA_TYPE",
+    "LEGACY_DRAWING_ROLE_ALIASES",
+    "MAX_DETAIL_BYTES",
+    "MAX_DIMENSIONS",
+    "MEASURE_TOLERANCE_MM",
+    "PDF_MEDIA_TYPE",
+    "SVG_MEDIA_TYPE",
+    "AssemblyDetailPackageError",
+    "AssemblyDetailPackageV1",
+    "AssemblyDrawingManifestV1",
+    "AssemblyDrawingResultV1",
+    "AssemblyStepV1",
+    "CustomerFacingName",
+    "CustomerSuppliedModelV1",
+    "CustomerSuppliedRowV1",
+    "DetailBindingV1",
+    "DetailReleaseRefV1",
+    "DetailUsageTermsV1",
+    "DimensionBasisV1",
+    "DimensionKindV1",
+    "DimensionV1",
+    "DrawingBalloonV1",
+    "DrawingBindingV1",
+    "DrawingDimensionV1",
+    "DrawingFileRoleV1",
+    "DrawingGeneratorRefV1",
+    "DrawingLocaleV1",
+    "DrawingOutputFileV1",
+    "DrawingSheetV1",
+    "DrawingStatusV1",
+    "DrawingValidationRefV1",
+    "DrawingViewKindV1",
+    "DrawingViewV1",
+    "MeasureAxisV1",
+    "MeasuredDimensionV1",
+    "OpticalSpacingRowV1",
+    "PartsLegendRowV1",
+    "PartsLegendV1",
+    "PointKindV1",
+    "PointRefV1",
+    "ReleaseBasisV1",
+    "SettingRefV1",
+    "StepActionV1",
+    "VerifiedAssemblyDetailV1",
+    "build_assembly_detail",
+    "detail_content_hash_of",
+    "detail_file_bytes",
+    "drawing_manifest_for",
+    "load_assembly_detail",
+    "measure",
+    "point_in_world",
+    "verify_assembly_detail",
+    "verify_drawing_outputs",
+]