flextool 4.0.0__py3-none-any.whl

flextool/solver_config/copt.opt.template

@@ -0,0 +1,18 @@
+# COPT baseline parameter file (FlexTool default).
+#
+# Format: one "<ParamName> <value>" per line.  Lines starting with "#"
+# are comments.  Consumed by FlexTool's commercial-solver subprocess
+# driver (flextool/engine_polars/_subprocess_solve.py): each non-comment
+# line is translated to ``set <ParamName> <value>`` and piped on stdin
+# to ``copt_cmd`` before ``read <mps>`` / ``optimize``.
+#
+# Any value set here is overridden line-by-line by the scenario's
+# ``solver_options`` Map (and by the translated convenience knobs
+# ``solver_time_limit`` / ``solver_mip_gap`` / ``solver_threads``).
+#
+# Reference: https://guide.coap.online/copt/en-doc/parameter.html
+#
+# Conservative defaults — edit to suit your model.
+Threads 1
+RelGap 0.002
+Logging 1

flextool/solver_config/cplex.opt.template

@@ -0,0 +1,25 @@
+# CPLEX baseline parameter file (FlexTool default).
+#
+# Format: one "<name> <value>" per line using CPLEX' interactive ``set``
+# command names (e.g. ``threads``, ``timelimit``, ``mip tolerances mipgap``).
+# Lines starting with "#" are comments.
+#
+# Consumed by FlexTool's commercial-solver subprocess driver
+# (flextool/engine_polars/_subprocess_solve.py): each non-comment line is
+# translated to ``set <name> <value>`` and piped on stdin to the
+# ``cplex`` interactive optimizer before ``read <mps>`` / ``optimize``.
+#
+# Why not a real CPLEX .prm file?  The CPLEX PRM format requires a
+# version header (e.g. ``CPLEX Parameter File Version 22.1.0.0``) that
+# the optimizer rejects when it doesn't match the installed binary's
+# version exactly.  Piping ``set`` commands is portable across CPLEX
+# 12.x / 20.x / 22.x.
+#
+# Any value set here is overridden line-by-line by the scenario's
+# ``solver_options`` Map (and by the translated convenience knobs).
+#
+# Reference: https://www.ibm.com/docs/en/icos/22.1.0?topic=cplex-list-parameters
+#
+# Conservative defaults — edit to suit your model.
+threads 1
+mip tolerances mipgap 0.002

flextool/solver_config/gurobi.opt.template

@@ -0,0 +1,18 @@
+# Gurobi baseline parameter file (FlexTool default).
+#
+# Format: Gurobi .prm — one "<ParamName> <value>" per line.
+# Lines starting with "#" are comments.  This file is consumed via
+#     gurobi_cl ReadParams=<this-file> ResultFile=<sol> <mps>
+# by FlexTool's commercial-solver subprocess driver
+# (flextool/engine_polars/_subprocess_solve.py).
+#
+# Any value set here is overridden line-by-line by the scenario's
+# ``solver_options`` Map (and by the translated convenience knobs
+# ``solver_time_limit`` / ``solver_mip_gap`` / ``solver_threads``).
+#
+# Reference: https://docs.gurobi.com/projects/optimizer/en/current/reference/parameters.html
+#
+# Conservative defaults — edit to suit your model.
+Threads 1
+MIPGap 0.002
+LogToConsole 1

flextool/solver_config/highs.opt.template

@@ -0,0 +1,18 @@
+write_solution_to_file=true
+solution_file=flextool.sol
+write_solution_style=2
+mip_report_level=2
+mip_heuristic_effort=0.5
+mip_detect_symmetry=true
+mip_rel_gap=0.002
+log_to_console=true
+# Serial dual simplex by default.  HiGHS PAMI (parallel dual simplex)
+# can stall indefinitely on degenerate LPs where a tiny post-optimality
+# residual (e.g. 1e-6) reappears after the quality rescan: concurrent
+# trajectories cannot agree on how to clear it and the Markowitz-bump
+# loop runs forever.  Observed across HiGHS 1.11 / 1.12 / 1.14 on
+# rivendell hydro-cascade and UC scenarios.  Enable parallel only if
+# PAMI is measurably faster on YOUR model AND your machine has >= 8
+# spare threads (PAMI concurrency is hardcoded to 8 inside HiGHS;
+# oversubscription makes the stall worse).
+parallel=off

flextool/solver_config/xpress.opt.template

@@ -0,0 +1,26 @@
+# Xpress baseline controls file (FlexTool default).
+#
+# Format: one "<CONTROL> <value>" per line.  Lines starting with "#"
+# are comments.  Consumed by FlexTool's commercial-solver subprocess
+# driver (flextool/engine_polars/_subprocess_solve.py): each non-comment
+# line is translated to ``setControl <CONTROL> <value>`` and piped on
+# stdin to the ``optimizer`` console before ``readprob <mps>`` /
+# ``lpoptimize``.
+#
+# Why not Xpress' native ``.ctl`` / ``readcontrols``?  ``readcontrols``
+# has been on-and-off across Xpress 8.x / 9.x and the file syntax
+# (binary vs ASCII, locale handling for floats) varies between
+# versions.  ``setControl`` from the optimizer console is the portable
+# escape hatch and matches what the rest of the per-solver dispatchers
+# in this driver do (Gurobi uses ReadParams, CPLEX uses inline ``set``,
+# COPT uses inline param-set commands).
+#
+# Any value set here is overridden line-by-line by the scenario's
+# ``solver_options`` Map (and by the translated convenience knobs).
+#
+# Reference: https://www.fico.com/fico-xpress-optimization/docs/dms2024-01/solver/optimizer/HTML/chapter6.html
+#
+# Conservative defaults — edit to suit your model.
+THREADS 1
+MIPRELSTOP 0.002
+OUTPUTLOG 1

flextool/spinedb_backend/__init__.py

@@ -0,0 +1,26 @@
+"""SpineDB → in-memory polars frames.
+
+The :class:`SpineDBBackend` is the canonical materialiser for the
+spec-driven entity / parameter / default-value tables consumed by the
+input-derivation cascade.
+
+Architecture
+------------
+
+::
+
+    SpineDB → SpineDBBackend → input_derivation → FlexDataProvider → cascade
+
+The Backend owns the EAV → tabular transformation.  Its methods return
+canonical-schema :class:`polars.DataFrame` objects; **no disk writes**
+happen anywhere in this package.  Disk emission is the Provider's job
+(via :meth:`flextool.engine_polars._flex_data_provider.FlexDataProvider.snapshot_processed_inputs`).
+
+See ``specs/step_2_5_audit.md`` Section 1 and Section 7 (items 1-4)
+for the migration plan.
+"""
+from __future__ import annotations
+
+from flextool.spinedb_backend._backend import SpineDBBackend
+
+__all__ = ["SpineDBBackend"]