lcsim 0.1.4__py3-none-any.whl

lcsim/__init__.py

@@ -0,0 +1,77 @@
+"""Public package exports for LCSim."""
+
+from typing import Any
+import importlib
+
+
+_LAZY_IMPORTS = {
+    "BC": "lcsim.shared",
+    "CONSERVATIVE_FAMILY_MODELS": "lcsim.shared",
+    "CONSYM_MODEL": "lcsim.shared",
+    "CONSYM_SUBSTRATE_MODEL": "lcsim.shared",
+    "DEFAULT_INTEGRATOR": "lcsim.shared",
+    "DEFAULT_MODEL": "lcsim.shared",
+    "MODEL_DESCRIPTOR_BY_ID": "lcsim.shared",
+    "MODEL_DESCRIPTORS": "lcsim.shared",
+    "MODEL_NAMES": "lcsim.shared",
+    "ModelDescriptor": "lcsim.shared",
+    "QCON_CAYLEY_FIXED_INTEGRATOR": "lcsim.shared",
+    "QCON_MODEL": "lcsim.shared",
+    "QISO_MODEL": "lcsim.shared",
+    "CayleyFixed": "lcsim.integrator",
+    "compile_substrate_geometry": "lcsim.substrate_geometry",
+    "Fehlberg": "lcsim.integrator",
+    "ParameterDelta": "lcsim.history_reader",
+    "MidpointEuler": "lcsim.integrator",
+    "Progress": "lcsim.utils",
+    "Settings": "lcsim.shared",
+    "Simulation": "lcsim.integrator",
+    "SimulationMetadata": "lcsim.shared",
+    "Simulator": "lcsim.simulators",
+    "State": "lcsim.simulators",
+    "StateException": "lcsim.shared",
+    "StaticFieldPayload": "lcsim.shared",
+    "SnapshotSADFrame": "lcsim.problem",
+    "SnapshotSADReader": "lcsim.problem",
+    "SnapshotSADWriter": "lcsim.problem",
+    "SubstrateColumnGeometry": "lcsim.substrate_geometry",
+    "annotate_image": ("lcsim.render_annotation", "annotate_image"),
+    "create_simulator": ("lcsim.simulators", "create_simulator"),
+    "get_coordinates": "lcsim.shared",
+    "get_model_descriptor": "lcsim.shared",
+    "is_conservative_family": "lcsim.shared",
+    "iter_model_descriptors": "lcsim.shared",
+    "load_from_npz": ("lcsim.legacy.npz", "load_from_npz"),
+    "load_runtime_state_from_npz": ("lcsim.legacy.npz", "load_runtime_state_from_npz"),
+    "load_snapshot_from_npz": ("lcsim.runtime.io", "load_snapshot_from_npz"),
+    "load_snapshot_sad": "lcsim.problem",
+    "load_substrate_geometry_json": "lcsim.substrate_geometry",
+    "mix_settings": "lcsim.shared",
+    "npfloat": "lcsim.shared",
+    "render_cp": ("lcsim.optics", "render_cp"),
+    "save_to_npz": ("lcsim.legacy.npz", "save_to_npz"),
+    "save_runtime_state_to_npz": ("lcsim.legacy.npz", "save_runtime_state_to_npz"),
+    "save_runtime_snapshot_to_npz": ("lcsim.runtime.io", "save_runtime_snapshot_to_npz"),
+    "save_snapshot_to_npz": ("lcsim.runtime.io", "save_snapshot_to_npz"),
+    "save_snapshot_sad": "lcsim.problem",
+    "scale_state": ("lcsim.runtime.io", "scale_state"),
+}
+
+
+def __getattr__(name: Any) -> Any:
+    """Internal helper for getattr."""
+    try:
+        target = _LAZY_IMPORTS[name]
+    except KeyError as exc:
+        raise AttributeError(name) from exc
+    if isinstance(target, str):
+        module_name, attr_name = target, name
+    else:
+        module_name, attr_name = target
+    module = importlib.import_module(module_name)
+    value = getattr(module, attr_name)
+    globals()[name] = value
+    return value
+
+
+__all__ = list(_LAZY_IMPORTS)

lcsim/bin/__init__.py

@@ -0,0 +1 @@
+"""Package initialization for lcsim.bin."""

lcsim/bin/_deprecation.py

@@ -0,0 +1,18 @@
+"""Shared notices for legacy console scripts."""
+
+from __future__ import annotations
+
+import sys
+
+
+def warn_legacy_entrypoint(command: str, replacement: str | None = None) -> None:
+    """Print a visible compatibility notice for legacy direct scripts."""
+    message = f"{command} is deprecated as a direct script."
+    if replacement:
+        message = f"{message} Use `{replacement}` instead."
+    else:
+        message = f"{message} Prefer `lcsim <mode>` where available."
+    print(f"DeprecationWarning: {message}", file=sys.stderr)
+
+
+__all__ = ["warn_legacy_entrypoint"]