flexcompute-core 0.0.1.dev0__tar.gz → 0.0.1.dev3__tar.gz

flexcompute_core-0.0.1.dev3/PKG-INFO

@@ -0,0 +1,73 @@
+Metadata-Version: 2.2
+Name: flexcompute-core
+Version: 0.0.1.dev3
+Summary: Shared internal modules for Flexcompute Python packages.
+Author-Email: "Flexcompute Inc." <support@flexcompute.com>
+Requires-Python: >=3.10
+Requires-Dist: pydantic<3,>=2.10.3
+Requires-Dist: tomlkit<0.16.0,>=0.13.2
+Requires-Dist: autograd<2.0.0,>=1.7.0
+Requires-Dist: numpy<2.5.0,>=2.2.6
+Requires-Dist: shapely<3.0,>=2.1.0
+Requires-Dist: trimesh<6.0.0,>=4.6
+Requires-Dist: boto3<2.0.0,>=1.28.0
+Requires-Dist: click<9.0.0,>=8.1.0
+Requires-Dist: cryptography==48.0.1; platform_system == "Darwin" and platform_machine == "x86_64"
+Requires-Dist: cryptography!=48.0.1,>=44.0.0; platform_system != "Darwin" or platform_machine != "x86_64"
+Requires-Dist: dask<2027.0.0,>=2025.12.0
+Requires-Dist: fastmcp<4,>=3.4.4
+Requires-Dist: filelock<4.0.0,>=3.20.1
+Requires-Dist: h5netcdf<2.0.0,>=1.0.2
+Requires-Dist: h5py<3.17,>=3.0.0; python_version < "3.14"
+Requires-Dist: h5py<3.17,>=3.16.0; python_version >= "3.14"
+Requires-Dist: importlib-metadata<10.0.0,>=6.0.0
+Requires-Dist: joblib<2.0.0,>=1.5.3
+Requires-Dist: matplotlib<4.0.0,>=3.10.0
+Requires-Dist: pandas<4.0,>=2.2
+Requires-Dist: pydantic-settings<3.0.0,>=2.10.0
+Requires-Dist: pyjwt<3.0.0,>=2.10.1
+Requires-Dist: pyroots<0.6.0,>=0.5.0
+Requires-Dist: PyYAML<7.0.0,>=6.0.3
+Requires-Dist: requests<3.0.0,>=2.31.0
+Requires-Dist: responses<0.27.0,>=0.25.8
+Requires-Dist: rich<16.0,>=13.0
+Requires-Dist: scipy!=1.15.0,!=1.15.1,!=1.15.2,<2.0,>=1.14
+Requires-Dist: toml<0.11.0,>=0.10.2
+Requires-Dist: typing-extensions<5.0.0,>=4.15.0
+Requires-Dist: xarray<2026.8.0,>=2023.08
+Description-Content-Type: text/markdown
+
+# flexcompute-core
+
+> Internal package — not intended for public-facing usage.
+
+`flexcompute-core` contains shared internal modules used across Flexcompute's
+Python packages under the `flexcompute.core` namespace.
+
+The EM schema, preprocessing, and numerical modules migrated from the retired
+standalone EM distribution are staged under `flexcompute.core._migration.em`.
+Solver workflow contracts that product translators lower tasks to, such as the
+component-modeler task input, are staged under `flexcompute.core._migration.solver`.
+Both namespaces are a temporary home and not a stable API; the modules move to
+their final `flexcompute.core` locations in follow-up changes.
+
+Shared plugin families that are not solver task contracts live temporarily in
+[`_migration/extensions`](src/flexcompute/core/_migration/extensions/README.md).
+This holds the design-space, dispersion-fitting and autograd helpers while their
+final shared namespaces are decided. Public product APIs stay in their owning
+clients.
+
+See the package [documentation](docs/configuration.md) for the configuration
+engine's responsibilities and development checks.
+
+It is not a standalone product, public client, or supported dependency for
+external applications. Product APIs and user-facing capabilities live in the
+owning product package.
+
+See [Flexcompute](https://www.flexcompute.com/) for product capabilities and
+the public [documentation](https://www.flexcompute.com/support/documentation/).
+
+Optical-medium comparison is shared through
+`_migration/em/material/medium/comparison.py`. Public and schema-native
+homogeneity checks use this owner to ignore names and user attributes without
+changing ordinary model equality, material indexing, or protected identities.

flexcompute_core-0.0.1.dev3/README.md

@@ -0,0 +1,34 @@
+# flexcompute-core
+
+> Internal package — not intended for public-facing usage.
+
+`flexcompute-core` contains shared internal modules used across Flexcompute's
+Python packages under the `flexcompute.core` namespace.
+
+The EM schema, preprocessing, and numerical modules migrated from the retired
+standalone EM distribution are staged under `flexcompute.core._migration.em`.
+Solver workflow contracts that product translators lower tasks to, such as the
+component-modeler task input, are staged under `flexcompute.core._migration.solver`.
+Both namespaces are a temporary home and not a stable API; the modules move to
+their final `flexcompute.core` locations in follow-up changes.
+
+Shared plugin families that are not solver task contracts live temporarily in
+[`_migration/extensions`](src/flexcompute/core/_migration/extensions/README.md).
+This holds the design-space, dispersion-fitting and autograd helpers while their
+final shared namespaces are decided. Public product APIs stay in their owning
+clients.
+
+See the package [documentation](docs/configuration.md) for the configuration
+engine's responsibilities and development checks.
+
+It is not a standalone product, public client, or supported dependency for
+external applications. Product APIs and user-facing capabilities live in the
+owning product package.
+
+See [Flexcompute](https://www.flexcompute.com/) for product capabilities and
+the public [documentation](https://www.flexcompute.com/support/documentation/).
+
+Optical-medium comparison is shared through
+`_migration/em/material/medium/comparison.py`. Public and schema-native
+homogeneity checks use this owner to ignore names and user attributes without
+changing ordinary model equality, material indexing, or protected identities.

flexcompute_core-0.0.1.dev3/docs/configuration.md

@@ -0,0 +1,29 @@
+# Configuration engine
+
+`flexcompute.core.config` provides product-neutral configuration mechanics:
+profile layering, Pydantic section validation, TOML persistence, atomic writes,
+schema migration execution, scoped runtime overrides, and per-section handlers.
+
+Products retain ownership of their public facades, section schemas, defaults,
+profile names, environment aliases, migration definitions, handlers, CLI
+commands, authentication validation, and endpoint catalogs. Core does not
+import product packages or product policy. Core tests the generic migration
+mechanism; products test their concrete migrations on their own surfaces.
+
+## Profile versioning
+
+`ConfigApp.version_profile_files` controls whether profile files include a
+`config_version` key and whether migrated profile files are written back to
+disk. Profile payloads still pass through the registered migration chain in
+memory so loaded data matches the current schema. Products that need truly
+unversioned, non-migrated profiles should supply a product-specific loader
+override.
+
+## Development
+
+Run the package checks from the `flex/public/flexcompute-core` directory:
+
+```bash
+uv run pytest
+uv run ruff check src tests
+```

flexcompute_core-0.0.1.dev3/pyproject.toml

@@ -0,0 +1,132 @@
+[build-system]
+requires = ["scikit_build_core==1.0.3"]
+build-backend = "scikit_build_core.build"
+
+[project]
+name = "flexcompute-core"
+version = "0.0.1.dev3"
+authors = [{ name = "Flexcompute Inc.", email = "support@flexcompute.com" }]
+description = "Shared internal modules for Flexcompute Python packages."
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+  # Shared core.
+  "pydantic>=2.10.3,<3",
+  "tomlkit>=0.13.2,<0.16.0",
+  # Shared geometry under flexcompute.geometry.
+  "autograd>=1.7.0,<2.0.0",
+  "numpy>=2.2.6,<2.5.0",
+  "shapely>=2.1.0,<3.0",
+  "trimesh>=4.6,<6.0.0",
+  # Temporary migrated EM contracts under flexcompute.core._migration.em.
+  "boto3>=1.28.0,<2.0.0",
+  "click>=8.1.0,<9.0.0",
+  "cryptography==48.0.1; platform_system == 'Darwin' and platform_machine == 'x86_64'",
+  "cryptography>=44.0.0,!=48.0.1; platform_system != 'Darwin' or platform_machine != 'x86_64'",
+  "dask>=2025.12.0,<2027.0.0",
+  "fastmcp>=3.4.4,<4",
+  "filelock>=3.20.1,<4.0.0",
+  "h5netcdf>=1.0.2,<2.0.0",
+  "h5py>=3.0.0,<3.17; python_version < '3.14'",
+  "h5py>=3.16.0,<3.17; python_version >= '3.14'",
+  "importlib-metadata>=6.0.0,<10.0.0",
+  "joblib>=1.5.3,<2.0.0",
+  "matplotlib>=3.10.0,<4.0.0",
+  "pandas>=2.2,<4.0",
+  "pydantic-settings>=2.10.0,<3.0.0",
+  "pyjwt>=2.10.1,<3.0.0",
+  "pyroots>=0.5.0,<0.6.0",
+  "PyYAML>=6.0.3,<7.0.0",
+  "requests>=2.31.0,<3.0.0",
+  "responses>=0.25.8,<0.27.0",
+  "rich>=13.0,<16.0",
+  "scipy>=1.14,<2.0,!=1.15.0,!=1.15.1,!=1.15.2",
+  "toml>=0.10.2,<0.11.0",
+  "typing-extensions>=4.15.0,<5.0.0",
+  "xarray>=2023.08,<2026.8.0",
+]
+
+[tool.scikit-build]
+# The root README is required by project.readme when rebuilding from an sdist.
+sdist.exclude = ["tests/**", "uv.lock", ".python-version", "src/**/README.md"]
+cmake.version = ">=3.15"
+wheel.cmake = false
+wheel.packages = ["src/flexcompute"]
+wheel.exclude = ["**/README.md"]
+minimum-version = "build-system.requires"
+
+[dependency-groups]
+dev = [
+  "pyrefly==1.3.0",
+  "pytest>=8.1,<10.0.0",
+  "ruff==0.14.1",
+  "scipy-stubs>=1.15.3,<2.0",
+]
+
+[tool.uv]
+default-groups = ["dev"]
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+testpaths = ["tests"]
+
+[tool.ruff]
+target-version = "py310"
+line-length = 100
+
+[tool.ruff.lint]
+# Pin the rule set instead of extending ruff's default selection, which changes
+# between ruff releases.
+select = ["E", "F", "B", "I", "UP", "W"]
+
+[tool.ruff.lint.per-file-ignores]
+# Preserve legacy docstring/zip style when relocating shared array primitives.
+"src/flexcompute/data/**" = ["E501", "B905"]
+# The temporary migrated EM tree keeps the pyflakes-only baseline it moved in with.
+"src/flexcompute/core/_migration/**" = ["B", "E", "I", "UP", "W"]
+"tests/_migration/**" = ["B", "E", "I", "UP", "W"]
+
+[tool.pyrefly]
+project-includes = [
+  "src/flexcompute/data",
+  "src/flexcompute/core/_migration/em",
+  "src/flexcompute/core/_migration/extensions",
+  "src/flexcompute/core/_migration/spice",
+  "src/flexcompute/core/_migration/tcad",
+  "src/flexcompute/geometry",
+]
+python-version = "3.10.0"
+preset = "off"
+ignore-missing-imports = ["*"]
+
+[tool.pyrefly.errors]
+# The migrated EM tree still contains legacy unannotated callables and attributes. Keep
+# the annotation-presence rules disabled until that baseline is migrated.
+deprecated = "error"
+redundant-cast = "error"
+redundant-condition = "error"
+invalid-literal = "error"
+unnecessary-type-conversion = "error"
+bad-raise = "error"
+bad-keyword-argument = "error"
+invalid-syntax = "error"
+implicit-any-attribute = "error"
+invalid-argument = "error"
+bad-override-param-name = "error"
+not-required-key-access = "error"
+
+# flexcompute.geometry is new, annotated code, so it is also checked for type errors.
+[[tool.pyrefly.sub-config]]
+matches = "src/flexcompute/geometry/**"
+# autograd ships no type information and builds these namespaces at import time.
+replace-imports-with-any = ["autograd.numpy", "autograd.numpy.linalg"]
+
+[tool.pyrefly.sub-config.errors]
+bad-argument-count = "error"
+bad-argument-type = "error"
+bad-assignment = "error"
+bad-return = "error"
+implicit-any-parameter = "error"
+missing-argument = "error"
+missing-attribute = "error"
+unexpected-keyword = "error"

flexcompute_core-0.0.1.dev3/src/flexcompute/core/_migration/__init__.py

@@ -0,0 +1 @@
+"""Temporary migration-only namespace for the first flexcompute development release."""

flexcompute_core-0.0.1.dev3/src/flexcompute/core/_migration/em/__init__.py

@@ -0,0 +1 @@
+"""Temporary migrated EM contracts for the first flexcompute development release."""

flexcompute_core-0.0.1.dev3/src/flexcompute/core/_migration/em/apodization/__init__.py

@@ -0,0 +1 @@
+"""Apodization validation scope."""

flexcompute_core-0.0.1.dev3/src/flexcompute/core/_migration/em/apodization/schema.py

@@ -0,0 +1,88 @@
+"""Defines specification for apodization."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+import numpy as np
+from pydantic import Field, NonNegativeFloat, PositiveFloat
+
+from flexcompute.core._migration.em.schema.tidy3d.components.base import Tidy3dBaseModel
+from flexcompute.core._migration.em.schema.tidy3d.components.viz import add_ax_if_none
+from flexcompute.core._migration.em.schema.tidy3d.constants import SECOND
+
+if TYPE_CHECKING:
+    from flexcompute.core._migration.em.schema.tidy3d.components.types import ArrayFloat1D, Ax
+
+
+class ApodizationSpec(Tidy3dBaseModel):
+    """Stores specifications for the apodizaton of frequency-domain monitors.
+
+    Example
+    -------
+    >>> apod_spec = ApodizationSpec(start=1, end=2, width=0.2)
+
+
+    .. image:: ../../_static/img/apodization.png
+        :width: 80%
+        :align: center
+
+    """
+
+    start: NonNegativeFloat | None = Field(
+        default=None,
+        title="Start Interval",
+        description="Defines the time at which the start apodization ends.",
+        json_schema_extra={"units": SECOND},
+    )
+
+    end: NonNegativeFloat | None = Field(
+        default=None,
+        title="End Interval",
+        description="Defines the time at which the end apodization begins.",
+        json_schema_extra={"units": SECOND},
+    )
+
+    width: PositiveFloat | None = Field(
+        default=None,
+        title="Apodization Width",
+        description="Characteristic decay length of the apodization function, i.e., the width of the ramping up of the scaling function from 0 to 1.",
+        json_schema_extra={"units": SECOND},
+    )
+
+    @add_ax_if_none
+    def plot(self, times: ArrayFloat1D, ax: Ax = None) -> Ax:
+        """Plot the apodization function.
+
+        Parameters
+        ----------
+        times : np.ndarray
+            Array of times (seconds) to plot source at.
+            To see source time amplitude for a specific :class:`.Simulation`,
+            pass ``simulation.tmesh``.
+        ax : matplotlib.axes._subplots.Axes = None
+            Matplotlib axes to plot on, if not specified, one is created.
+
+        Returns
+        -------
+        matplotlib.axes._subplots.Axes
+            The supplied or created matplotlib axes.
+        """
+        times = np.array(times)
+        amp = np.ones_like(times)
+
+        if self.start is not None:
+            start_ind = times < self.start
+            time_scaled = (times[start_ind] - self.start) / self.width
+            amp[start_ind] *= np.exp(-0.5 * time_scaled**2)
+
+        if self.end is not None:
+            end_ind = times > self.end
+            time_scaled = (times[end_ind] - self.end) / self.width
+            amp[end_ind] *= np.exp(-0.5 * time_scaled**2)
+
+        ax.plot(times, amp, color="blueviolet")
+        ax.set_xlabel("time (s)")
+        ax.set_title("apodization function")
+        ax.set_aspect("auto")
+        return ax

flexcompute_core-0.0.1.dev3/src/flexcompute/core/_migration/em/apodization/validation.py

@@ -0,0 +1,54 @@
+"""Pure rules for apodization validation."""
+
+from __future__ import annotations
+
+from flexcompute.core.validation import ValidationDiagnostic, ValidationReport, error
+
+
+def validate_end_order(start: float | None, end: float | None) -> tuple[ValidationDiagnostic, ...]:
+    """Require the end apodization to begin no earlier than the start apodization ends."""
+    if start is not None and end is not None and end < start:
+        return (
+            error(
+                "em.apodization.end_greater_than_start",
+                "End apodization begins before start apodization ends.",
+                ("end",),
+            ),
+        )
+    return ()
+
+
+def validate_width(
+    start: float | None, end: float | None, width: float | None
+) -> tuple[ValidationDiagnostic, ...]:
+    """Require a width when either the start or the end apodization is requested."""
+    if (start is not None or end is not None) and width is None:
+        return (
+            error(
+                "em.apodization.width_provided",
+                "Apodization width must be set.",
+                ("width",),
+            ),
+        )
+    return ()
+
+
+def validate(schema: object) -> ValidationReport:
+    """Validate a moved apodization spec in the order of the replaced validators.
+
+    The end-before-start rule comes first, as that validator ran first, so the first error
+    matches the public constructor.
+
+    The validation dispatch calls this on every node whose class has this scope. A node of
+    any other class reports nothing.
+    """
+    from .schema import ApodizationSpec
+
+    if not isinstance(schema, ApodizationSpec):
+        return ValidationReport()
+    return ValidationReport(
+        diagnostics=(
+            *validate_end_order(schema.start, schema.end),
+            *validate_width(schema.start, schema.end, schema.width),
+        )
+    )

flexcompute_core-0.0.1.dev3/src/flexcompute/core/_migration/em/boundary/__init__.py

@@ -0,0 +1 @@
+"""Boundary-condition validation scope."""

flexcompute_core-0.0.1.dev3/src/flexcompute/core/_migration/em/boundary/placement/__init__.py

@@ -0,0 +1 @@
+"""Boundary-placement validation scope."""

flexcompute_core-0.0.1.dev3/src/flexcompute/core/_migration/em/boundary/placement/schema.py

@@ -0,0 +1,101 @@
+"""Defines placements for boundary conditions."""
+
+from __future__ import annotations
+
+from abc import ABC
+
+from pydantic import Field
+
+from flexcompute.core._migration.em.schema.tidy3d.components.types.base import discriminated_union
+from flexcompute.core._migration.em.schema.tidy3d.components.base import Tidy3dBaseModel
+from flexcompute.core._migration.em.schema.tidy3d.components.types import BoxSurface
+
+
+class AbstractBCPlacement(ABC, Tidy3dBaseModel):
+    """Abstract placement for boundary conditions."""
+
+
+class StructureBoundary(AbstractBCPlacement):
+    """Placement of boundary conditions on the structure's boundary.
+
+    Example
+    -------
+    >>> bc_placement = StructureBoundary(structure="box")
+    """
+
+    structure: str = Field(
+        title="Structure Name",
+        description="Name of the structure.",
+    )
+
+
+class StructureStructureInterface(AbstractBCPlacement):
+    """Placement of boundary conditions between two structures.
+
+    Example
+    -------
+    >>> bc_placement = StructureStructureInterface(structures=["box", "sphere"])
+    """
+
+    structures: tuple[str, str] = Field(
+        title="Structures",
+        description="Names of two structures.",
+    )
+
+
+class MediumMediumInterface(AbstractBCPlacement):
+    """Placement of boundary conditions between two mediums.
+
+    Example
+    -------
+    >>> bc_placement = MediumMediumInterface(mediums=["dieletric", "metal"])
+    """
+
+    mediums: tuple[str, str] = Field(
+        title="Mediums",
+        description="Names of two mediums.",
+    )
+
+
+class SimulationBoundary(AbstractBCPlacement):
+    """Placement of boundary conditions on the simulation box boundary.
+
+    Example
+    -------
+    >>> bc_placement = SimulationBoundary(surfaces=["x-", "x+"])
+    """
+
+    surfaces: tuple[BoxSurface, ...] = Field(
+        default=("x-", "x+", "y-", "y+", "z-", "z+"),
+        title="Surfaces",
+        description="Surfaces of simulation domain where to apply boundary conditions.",
+    )
+
+
+class StructureSimulationBoundary(AbstractBCPlacement):
+    """Placement of boundary conditions on the simulation box boundary covered by the structure.
+
+    Example
+    -------
+    >>> bc_placement = StructureSimulationBoundary(structure="box", surfaces=["y-", "y+"])
+    """
+
+    structure: str = Field(
+        title="Structure Name",
+        description="Name of the structure.",
+    )
+
+    surfaces: tuple[BoxSurface, ...] = Field(
+        default=("x-", "x+", "y-", "y+", "z-", "z+"),
+        title="Surfaces",
+        description="Surfaces of simulation domain where to apply boundary conditions.",
+    )
+
+
+BCPlacementType = discriminated_union(
+    StructureBoundary
+    | StructureStructureInterface
+    | MediumMediumInterface
+    | SimulationBoundary
+    | StructureSimulationBoundary
+)

flexcompute_core-0.0.1.dev3/src/flexcompute/core/_migration/em/boundary/placement/validation.py

@@ -0,0 +1,42 @@
+"""Pure rules for boundary-condition placements."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from flexcompute.core.validation import ValidationDiagnostic, ValidationReport, error
+
+if TYPE_CHECKING:
+    from .schema import MediumMediumInterface, StructureStructureInterface
+
+
+def validate_distinct_names(
+    interface: StructureStructureInterface | MediumMediumInterface,
+) -> tuple[ValidationDiagnostic, ...]:
+    """Reject an interface that names the same structure or medium twice."""
+    from .schema import StructureStructureInterface
+
+    if isinstance(interface, StructureStructureInterface):
+        field, kind, owner = "structures", "structure", "StructureStructureInterface"
+    else:
+        field, kind, owner = "mediums", "medium", "MediumMediumInterface"
+    names = getattr(interface, field)
+    if names[0] != names[1]:
+        return ()
+    return (
+        error(
+            f"em.boundary.placement.duplicate_{kind}",
+            f"The same {kind} is provided twice in '{owner}'.",
+            (field,),
+        ),
+    )
+
+
+def validate(schema: object) -> ValidationReport:
+    """Run the placement rules for one node; any other node reports nothing."""
+    from .schema import MediumMediumInterface, StructureStructureInterface
+
+    diagnostics = ()
+    if isinstance(schema, (StructureStructureInterface, MediumMediumInterface)):
+        diagnostics = validate_distinct_names(schema)
+    return ValidationReport(diagnostics=diagnostics)