lcsim 0.1.4__tar.gz

lcsim-0.1.4/.gitignore

@@ -0,0 +1,24 @@
+*.mp4
+/refs/
+**/.ipynb_checkpoints/
+**/__pycache__/
+**/file_system_store/
+*.png
+profile
+*.mpg
+/*.egg-info
+.pytest_cache
+/tmp*/
+/sandbox/
+/.vscode/
+/_cache
+/.idea
+/output/
+/desktop_gui/binaries
+
+/env*
+/build
+/dist
+/tex/build
+/AI
+*.tar.gz

lcsim-0.1.4/LICENSE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright 2025 Igor Lobanov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

lcsim-0.1.4/PKG-INFO

@@ -0,0 +1,218 @@
+Metadata-Version: 2.4
+Name: lcsim
+Version: 0.1.4
+Summary: LCSim - liquid crystal simulator.
+Project-URL: Repository, https://gitlab.com/alepoydes/lcsim
+Project-URL: Issues, https://gitlab.com/alepoydes/lcsim/-/issues
+Author-email: Igor Lobanov <lobanov.igor@gmail.com>
+License-Expression: MIT
+License-File: LICENSE.md
+Keywords: dynamics,liquid crystal,physics
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Topic :: Scientific/Engineering :: Physics
+Requires-Python: >=3.10
+Requires-Dist: numpy>=2.1
+Requires-Dist: rich>=13.9.4
+Requires-Dist: topovec>=0.1.8
+Provides-Extra: all-cu
+Requires-Dist: ffmpeg-python; extra == 'all-cu'
+Requires-Dist: moderngl>=5.12.0; extra == 'all-cu'
+Requires-Dist: numba-cuda[cu13]; extra == 'all-cu'
+Requires-Dist: numba>=0.61; extra == 'all-cu'
+Requires-Dist: requests; extra == 'all-cu'
+Requires-Dist: sadcompressor>=0.1.1; extra == 'all-cu'
+Requires-Dist: scipy>=1.15.2; extra == 'all-cu'
+Requires-Dist: topovec[cuda]; extra == 'all-cu'
+Requires-Dist: topovec[render,sad,ti]; extra == 'all-cu'
+Requires-Dist: topovec[sad,ti,video,view]; extra == 'all-cu'
+Requires-Dist: topovec[sad]; extra == 'all-cu'
+Requires-Dist: topovec[view]; extra == 'all-cu'
+Provides-Extra: all-cu12
+Requires-Dist: ffmpeg-python; extra == 'all-cu12'
+Requires-Dist: moderngl>=5.12.0; extra == 'all-cu12'
+Requires-Dist: numba-cuda[cu12]; extra == 'all-cu12'
+Requires-Dist: numba>=0.61; extra == 'all-cu12'
+Requires-Dist: requests; extra == 'all-cu12'
+Requires-Dist: sadcompressor>=0.1.1; extra == 'all-cu12'
+Requires-Dist: scipy>=1.15.2; extra == 'all-cu12'
+Requires-Dist: topovec[render,sad,ti]; extra == 'all-cu12'
+Requires-Dist: topovec[sad,ti,video,view]; extra == 'all-cu12'
+Requires-Dist: topovec[sad]; extra == 'all-cu12'
+Requires-Dist: topovec[view]; extra == 'all-cu12'
+Provides-Extra: all-cu13
+Requires-Dist: ffmpeg-python; extra == 'all-cu13'
+Requires-Dist: moderngl>=5.12.0; extra == 'all-cu13'
+Requires-Dist: numba-cuda[cu13]; extra == 'all-cu13'
+Requires-Dist: numba>=0.61; extra == 'all-cu13'
+Requires-Dist: requests; extra == 'all-cu13'
+Requires-Dist: sadcompressor>=0.1.1; extra == 'all-cu13'
+Requires-Dist: scipy>=1.15.2; extra == 'all-cu13'
+Requires-Dist: topovec[cuda]; extra == 'all-cu13'
+Requires-Dist: topovec[render,sad,ti]; extra == 'all-cu13'
+Requires-Dist: topovec[sad,ti,video,view]; extra == 'all-cu13'
+Requires-Dist: topovec[sad]; extra == 'all-cu13'
+Requires-Dist: topovec[view]; extra == 'all-cu13'
+Provides-Extra: dev
+Requires-Dist: pytest>=8.3; extra == 'dev'
+Provides-Extra: gpu-cu12
+Requires-Dist: numba-cuda[cu12]; extra == 'gpu-cu12'
+Requires-Dist: numba>=0.61; extra == 'gpu-cu12'
+Provides-Extra: gpu-cu13
+Requires-Dist: numba-cuda[cu13]; extra == 'gpu-cu13'
+Requires-Dist: numba>=0.61; extra == 'gpu-cu13'
+Requires-Dist: topovec[cuda]; extra == 'gpu-cu13'
+Provides-Extra: gpu-legacy
+Requires-Dist: numba<0.63,>=0.61; extra == 'gpu-legacy'
+Provides-Extra: gui
+Requires-Dist: topovec[view]; extra == 'gui'
+Provides-Extra: gui-cu12
+Requires-Dist: numba-cuda[cu12]; extra == 'gui-cu12'
+Requires-Dist: numba>=0.61; extra == 'gui-cu12'
+Requires-Dist: topovec[view]; extra == 'gui-cu12'
+Provides-Extra: gui-cu13
+Requires-Dist: numba-cuda[cu13]; extra == 'gui-cu13'
+Requires-Dist: numba>=0.61; extra == 'gui-cu13'
+Requires-Dist: topovec[cuda]; extra == 'gui-cu13'
+Requires-Dist: topovec[view]; extra == 'gui-cu13'
+Provides-Extra: gui-legacy
+Requires-Dist: numba<0.63,>=0.61; extra == 'gui-legacy'
+Requires-Dist: topovec[view]; extra == 'gui-legacy'
+Provides-Extra: legacy-render
+Requires-Dist: ffmpeg-python; extra == 'legacy-render'
+Requires-Dist: moderngl>=5.12.0; extra == 'legacy-render'
+Requires-Dist: sadcompressor>=0.1.1; extra == 'legacy-render'
+Provides-Extra: optics
+Requires-Dist: scipy>=1.15.2; extra == 'optics'
+Provides-Extra: render
+Requires-Dist: topovec[render,sad,ti]; extra == 'render'
+Provides-Extra: run-cu12
+Requires-Dist: numba-cuda[cu12]; extra == 'run-cu12'
+Requires-Dist: numba>=0.61; extra == 'run-cu12'
+Requires-Dist: sadcompressor>=0.1.1; extra == 'run-cu12'
+Requires-Dist: topovec[sad]; extra == 'run-cu12'
+Provides-Extra: run-cu13
+Requires-Dist: numba-cuda[cu13]; extra == 'run-cu13'
+Requires-Dist: numba>=0.61; extra == 'run-cu13'
+Requires-Dist: sadcompressor>=0.1.1; extra == 'run-cu13'
+Requires-Dist: topovec[cuda]; extra == 'run-cu13'
+Requires-Dist: topovec[sad]; extra == 'run-cu13'
+Provides-Extra: run-legacy
+Requires-Dist: numba<0.63,>=0.61; extra == 'run-legacy'
+Requires-Dist: sadcompressor>=0.1.1; extra == 'run-legacy'
+Requires-Dist: topovec[sad]; extra == 'run-legacy'
+Provides-Extra: run-notify
+Requires-Dist: requests; extra == 'run-notify'
+Provides-Extra: sad
+Requires-Dist: sadcompressor>=0.1.1; extra == 'sad'
+Requires-Dist: topovec[sad]; extra == 'sad'
+Provides-Extra: test
+Requires-Dist: pytest>=8.3; extra == 'test'
+Provides-Extra: tests
+Requires-Dist: pytest>=8.3; extra == 'tests'
+Provides-Extra: view
+Requires-Dist: sadcompressor>=0.1.1; extra == 'view'
+Requires-Dist: topovec[sad,ti,video,view]; extra == 'view'
+Description-Content-Type: text/markdown
+
+# LCSim
+
+Liquid crystal simulation tools and command-line utilities.
+
+## Installation
+
+LCSim is published on PyPI. For regular use, install it as a `uv` tool.
+Detailed OS-specific instructions:
+
+- Windows: [WINDOWS-INSTALL.md](WINDOWS-INSTALL.md)
+- Ubuntu: [UBUNTU-INSTALL.md](UBUNTU-INSTALL.md)
+
+The default dependency set is intentionally light: it is enough for the
+`lcsim` dispatcher and shared Python code, but not for running simulations,
+opening the GUI, viewing files, or rendering videos. Install one profile for
+the workflow you actually use. Do not install every extra at once: CUDA profiles conflict by design.
+For every runtime mode in one environment, use `all-cu` (`all-cu13`) or
+`all-cu12`. For one mode, use a convenience profile such as `run-cu13` or `gui-cu13`.
+For a mixed environment, choose one low-level GPU extra such as `gpu-cu13` and
+add non-conflicting feature extras (`sad`, `gui`, `view`, `render`, `run-notify`) around it.
+
+Recommended PyPI tool installs:
+
+```sh
+# All runtime modes, recommended CUDA 13 profile.
+uv tool install 'lcsim[all-cu]'
+
+# Batch simulation, recommended CUDA 13 profile.
+uv tool install 'lcsim[run-cu13]'
+
+# Interactive GUI, recommended CUDA 13 profile.
+uv tool install 'lcsim[gui-cu13]'
+
+# New TopoVec-based renderer for SAD/TopoVec state files.
+uv tool install 'lcsim[render]'
+
+# Saved-file viewer with LCSIM scenes and TopoVec scenes.
+uv tool install 'lcsim[view]'
+
+# Optional Telegram notifications for `lcsim run`.
+uv tool install 'lcsim[run-cu13,run-notify]'
+
+# Combined run + GUI environment with one shared GPU profile.
+uv tool install 'lcsim[gpu-cu13,sad,gui]'
+```
+
+`all-cu` and `all-cu13` install the CUDA 13 runtime, TopoVec CUDA backend,
+`lcsim run`, `lcsim gui`, `lcsim view`, `lcsim render`, run notifications,
+optics, and legacy renderer Python dependencies. `all-cu12` keeps the lcsim
+runtime on the CUDA 12 family and omits TopoVec's CUDA 13-only CUDA backend.
+Legacy `lcsrender` still needs a system `ffmpeg` executable on `PATH`.
+
+For one-off execution without installing persistent commands:
+
+```sh
+uvx --from 'lcsim[run-cu13]' lcsim run --help
+uvx --from 'lcsim[gui-cu13]' lcsim gui --help
+```
+
+From a repository checkout, use the same extras with `uv sync --extra ...` and
+run commands with `uv run ...`.
+
+## Command-line tools
+
+The primary public entry point is now `lcsim`:
+
+```sh
+lcsim --help
+lcsim run --help
+lcsim gui --help
+lcsim view --help
+lcsim render --help
+```
+
+Typical usage:
+
+```sh
+# Run an off-screen simulation.
+lcsim run --preset consym --history HISTORY.json --period 10 --output --sad
+
+# Open the interactive viewer.
+lcsim gui
+
+# View a saved simulation state without starting CUDA runtime.
+lcsim view run.sad
+
+# Render a SAD file with simulation-time video sampling.
+lcsim render run.sad --scene "Jones RGB" --output run.mp4 --fps 25
+```
+
+Legacy commands remain available as compatibility wrappers, but they print a
+deprecation notice:
+
+- [`lcsrun`](doc/lcsrun.md): use `lcsim run ...` for new workflows.
+- [`lcsgui`](doc/lcsgui.md): use `lcsim gui ...` for new workflows.
+- [`lcsrender`](doc/lcsrender.md): legacy renderer; use `lcsim render ...` for the new renderer.
+- `lcsoptics`: optional optics utility. Install the `optics` extra if you want to use it.
+
+Legacy `lcsrender` requires a system `ffmpeg` executable on `PATH`; the new
+`lcsim run` path writes SAD and leaves video generation to `lcsim render`.

lcsim-0.1.4/README.md

@@ -0,0 +1,100 @@
+# LCSim
+
+Liquid crystal simulation tools and command-line utilities.
+
+## Installation
+
+LCSim is published on PyPI. For regular use, install it as a `uv` tool.
+Detailed OS-specific instructions:
+
+- Windows: [WINDOWS-INSTALL.md](WINDOWS-INSTALL.md)
+- Ubuntu: [UBUNTU-INSTALL.md](UBUNTU-INSTALL.md)
+
+The default dependency set is intentionally light: it is enough for the
+`lcsim` dispatcher and shared Python code, but not for running simulations,
+opening the GUI, viewing files, or rendering videos. Install one profile for
+the workflow you actually use. Do not install every extra at once: CUDA profiles conflict by design.
+For every runtime mode in one environment, use `all-cu` (`all-cu13`) or
+`all-cu12`. For one mode, use a convenience profile such as `run-cu13` or `gui-cu13`.
+For a mixed environment, choose one low-level GPU extra such as `gpu-cu13` and
+add non-conflicting feature extras (`sad`, `gui`, `view`, `render`, `run-notify`) around it.
+
+Recommended PyPI tool installs:
+
+```sh
+# All runtime modes, recommended CUDA 13 profile.
+uv tool install 'lcsim[all-cu]'
+
+# Batch simulation, recommended CUDA 13 profile.
+uv tool install 'lcsim[run-cu13]'
+
+# Interactive GUI, recommended CUDA 13 profile.
+uv tool install 'lcsim[gui-cu13]'
+
+# New TopoVec-based renderer for SAD/TopoVec state files.
+uv tool install 'lcsim[render]'
+
+# Saved-file viewer with LCSIM scenes and TopoVec scenes.
+uv tool install 'lcsim[view]'
+
+# Optional Telegram notifications for `lcsim run`.
+uv tool install 'lcsim[run-cu13,run-notify]'
+
+# Combined run + GUI environment with one shared GPU profile.
+uv tool install 'lcsim[gpu-cu13,sad,gui]'
+```
+
+`all-cu` and `all-cu13` install the CUDA 13 runtime, TopoVec CUDA backend,
+`lcsim run`, `lcsim gui`, `lcsim view`, `lcsim render`, run notifications,
+optics, and legacy renderer Python dependencies. `all-cu12` keeps the lcsim
+runtime on the CUDA 12 family and omits TopoVec's CUDA 13-only CUDA backend.
+Legacy `lcsrender` still needs a system `ffmpeg` executable on `PATH`.
+
+For one-off execution without installing persistent commands:
+
+```sh
+uvx --from 'lcsim[run-cu13]' lcsim run --help
+uvx --from 'lcsim[gui-cu13]' lcsim gui --help
+```
+
+From a repository checkout, use the same extras with `uv sync --extra ...` and
+run commands with `uv run ...`.
+
+## Command-line tools
+
+The primary public entry point is now `lcsim`:
+
+```sh
+lcsim --help
+lcsim run --help
+lcsim gui --help
+lcsim view --help
+lcsim render --help
+```
+
+Typical usage:
+
+```sh
+# Run an off-screen simulation.
+lcsim run --preset consym --history HISTORY.json --period 10 --output --sad
+
+# Open the interactive viewer.
+lcsim gui
+
+# View a saved simulation state without starting CUDA runtime.
+lcsim view run.sad
+
+# Render a SAD file with simulation-time video sampling.
+lcsim render run.sad --scene "Jones RGB" --output run.mp4 --fps 25
+```
+
+Legacy commands remain available as compatibility wrappers, but they print a
+deprecation notice:
+
+- [`lcsrun`](doc/lcsrun.md): use `lcsim run ...` for new workflows.
+- [`lcsgui`](doc/lcsgui.md): use `lcsim gui ...` for new workflows.
+- [`lcsrender`](doc/lcsrender.md): legacy renderer; use `lcsim render ...` for the new renderer.
+- `lcsoptics`: optional optics utility. Install the `optics` extra if you want to use it.
+
+Legacy `lcsrender` requires a system `ffmpeg` executable on `PATH`; the new
+`lcsim run` path writes SAD and leaves video generation to `lcsim render`.

lcsim-0.1.4/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-0.1.4/lcsim/bin/__init__.py

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

lcsim-0.1.4/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"]