specsolve 0.1.0__py3-none-any.whl

specsolve/__init__.py

@@ -0,0 +1,71 @@
+"""Declarative optimisation: YAML math on a streaming engine.
+
+Specs build relationally on polars and stream to the solver — see
+docs/about/architecture.md.
+
+Example::
+
+    import specsolve as sps
+
+    result = sps.solve('spec.yaml', {'p_max': 'p_max.parquet', 'load': 'load.parquet'})
+    result.objective
+    result.primal('p')  # tidy polars.DataFrame
+    result.to_dataarray('p')  # labelled, for array post-processing
+
+``__version__`` reads the installed metadata: the git tag is the source of
+truth, and hatch-vcs bakes it in at build time. A source tree with nothing
+installed reads ``0.0.0``.
+"""
+
+from importlib.metadata import PackageNotFoundError as _PackageNotFoundError
+from importlib.metadata import version as _installed_version
+
+from specsolve.api import Model, build, check, evaluate, load_result, scan_result, solve, write
+from specsolve.archive import SolveArchive, SweepArchive, load_archive, scan_archive
+from specsolve.errors import (
+    DataError,
+    DimensionError,
+    LanguageError,
+    LayoutError,
+    NoSolutionError,
+    SchemaError,
+    SpecsolveError,
+    SpecsolveWarning,
+)
+from specsolve.relational.result import Result
+from specsolve.strategy import EachCoordinate, EachWindow, Sweep, load_sweep, scan_sweep, solve_over
+
+__all__ = [
+    'DataError',
+    'DimensionError',
+    'EachCoordinate',
+    'EachWindow',
+    'LanguageError',
+    'LayoutError',
+    'Model',
+    'NoSolutionError',
+    'Result',
+    'SchemaError',
+    'SolveArchive',
+    'SpecsolveError',
+    'SpecsolveWarning',
+    'Sweep',
+    'SweepArchive',
+    'build',
+    'check',
+    'evaluate',
+    'load_archive',
+    'load_result',
+    'load_sweep',
+    'scan_archive',
+    'scan_result',
+    'scan_sweep',
+    'solve',
+    'solve_over',
+    'write',
+]
+
+try:
+    __version__ = _installed_version('specsolve')
+except _PackageNotFoundError:
+    __version__ = '0.0.0'