ies-optimiser 2026.9.0__tar.gz

ies_optimiser-2026.9.0/CMakeLists.txt

@@ -0,0 +1,43 @@
+# Gréoux Research (2024). IES Optimiser: a linear optimiser-based integrated energy system modelling environment. https://github.com/greoux-research/ies-optimiser
+#
+# Builds the thermodynamics executable (thermo/*.cpp) and installs it inside
+# the Python package, at ies_optimiser/_bin/ies-optimiser-thermo (ies-optimiser-thermo.exe on Windows).
+# Run by scikit-build-core during 'python -m build' or 'pip install'; see
+# pyproject.toml. It is a standalone executable called as a subprocess, not a
+# Python extension.
+
+cmake_minimum_required(VERSION 3.15...3.31)
+project(ies_optimiser_thermo LANGUAGES CXX)
+
+# Compiled with the flags of thermo/build.sh, the build that produced the
+# reference executable (g++ -fPIC -Wall, no optimisation flag and no -std
+# flag), so the packaged tool performs the same floating-point operations. The
+# build type's own flags (Release adds -O3 -DNDEBUG) are deliberately cleared.
+foreach(config RELEASE RELWITHDEBINFO MINSIZEREL DEBUG)
+  set(CMAKE_CXX_FLAGS_${config} "")
+endforeach()
+
+# On Windows the C++ runtime is linked statically (/MT): the executable is run
+# as a separate process, outside Python's DLL directories, and msvcp140.dll is
+# not guaranteed on a clean system. tools/inspect_native.py checks the result.
+set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>")
+
+add_executable(ies-optimiser-thermo thermo/sim.cpp thermo/Cogen.cpp thermo/iesOptimiserH2O.cpp)
+set_target_properties(ies-optimiser-thermo PROPERTIES POSITION_INDEPENDENT_CODE ON)
+if(MSVC)
+  target_compile_options(ies-optimiser-thermo PRIVATE /W4)
+else()
+  target_compile_options(ies-optimiser-thermo PRIVATE -Wall)
+endif()
+if(UNIX)
+  target_link_libraries(ies-optimiser-thermo PRIVATE m)
+endif()
+
+# SKBUILD_PLATLIB_DIR is the wheel's platform-library root when built by
+# scikit-build-core; a plain 'cmake --install' uses the prefix instead.
+if(DEFINED SKBUILD_PLATLIB_DIR)
+  set(IES_OPTIMISER_BIN_DESTINATION "${SKBUILD_PLATLIB_DIR}/ies_optimiser/_bin")
+else()
+  set(IES_OPTIMISER_BIN_DESTINATION "ies_optimiser/_bin")
+endif()
+install(TARGETS ies-optimiser-thermo RUNTIME DESTINATION "${IES_OPTIMISER_BIN_DESTINATION}")

ies_optimiser-2026.9.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Gréoux Research
+
+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.

ies_optimiser-2026.9.0/PKG-INFO

@@ -0,0 +1,100 @@
+Metadata-Version: 2.4
+Name: ies-optimiser
+Version: 2026.9.0
+Summary: IES Optimiser: a linear optimiser-based integrated energy system modelling environment
+Keywords: energy system,optimisation,linear programming,power-to-x,cogeneration
+Author: Gréoux Research
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: C++
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Topic :: Scientific/Engineering
+Classifier: Typing :: Typed
+Project-URL: Homepage, https://github.com/greoux-research/ies-optimiser
+Project-URL: Documentation, https://github.com/greoux-research/ies-optimiser/tree/main/docs
+Project-URL: Source, https://github.com/greoux-research/ies-optimiser
+Project-URL: Issues, https://github.com/greoux-research/ies-optimiser/issues
+Project-URL: Changelog, https://github.com/greoux-research/ies-optimiser/blob/main/CHANGELOG.md
+Requires-Python: >=3.11
+Requires-Dist: numpy<3,>=2.0
+Requires-Dist: ortools<10,>=9.15
+Requires-Dist: pydantic<3,>=2.11
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: jsonschema>=4.18; extra == "dev"
+Requires-Dist: mypy>=1.10; extra == "dev"
+Requires-Dist: build>=1.2; extra == "dev"
+Description-Content-Type: text/markdown
+
+# IES Optimiser
+
+IES Optimiser (*Integrated Energy Systems Optimiser*) is a linear optimiser-based energy system modelling environment designed to support initial investigations such as options evaluation and trend analysis. It sizes and dispatches generators, storage and Power-to-X processes (electrolysis, desalination, cogeneration heat) over a year of hourly steps, with OR-Tools' GLOP solver.
+
+- [Modelling Approach](https://github.com/greoux-research/ies-optimiser/blob/main/docs/ies-optimiser-modelling-approach.md)
+- [Setup Guide](https://github.com/greoux-research/ies-optimiser/blob/main/docs/ies-optimiser-setup-guide.md)
+- [IO File Structure](https://github.com/greoux-research/ies-optimiser/blob/main/docs/ies-optimiser-io-file-structure.md)
+- [Inputs, Validation and the Python API](https://github.com/greoux-research/ies-optimiser/blob/main/docs/ies-optimiser-api.md)
+- [Supported Platforms](https://github.com/greoux-research/ies-optimiser/blob/main/docs/support-matrix.md)
+- [Changelog](https://github.com/greoux-research/ies-optimiser/blob/main/CHANGELOG.md)
+- [Baseline Verification](https://github.com/greoux-research/ies-optimiser/blob/main/docs/baseline-verification.md)
+
+## Installation
+
+IES Optimiser needs Python 3.11 or later, on Linux x86_64 (glibc 2.28+), macOS (Apple Silicon 11+, Intel 10.15+) or Windows x86_64. Wheels include the compiled thermodynamics executable; no compiler is needed.
+
+Install it from PyPI into a fresh virtual environment:
+
+```bash
+python3 -m venv ies-optimiser-env
+source ies-optimiser-env/bin/activate          # Windows: ies-optimiser-env\Scripts\activate
+python -m pip install ies-optimiser
+```
+
+To install a wheel file or a development checkout instead, see the [Setup Guide](https://github.com/greoux-research/ies-optimiser/blob/main/docs/ies-optimiser-setup-guide.md).
+
+## Use
+
+A synthetic demonstration case (a solar, gas and battery system; MIT-licensed, like the code) is in the repository's [`examples/`](https://github.com/greoux-research/ies-optimiser/tree/main/examples) folder, with a thermally coupled Power-to-X case beside it; `python tools/build_examples.py` regenerates both in a checkout. From a directory holding a copy of `examples/`:
+
+<!-- tested -->
+```bash
+ies-optimiser validate examples/electricity-storage/case.json      # check without solving
+ies-optimiser examples/electricity-storage/case.json carbon-constraint=150
+# -> examples/electricity-storage/case.ies-optimiser.carbon-constraint_150.0.json
+```
+
+<!-- tested -->
+```python
+import ies_optimiser
+
+result = ies_optimiser.solve('examples/power-to-x-thermal/case.json')
+if result.optimal and result.accounting_ok:
+    print(result.document['system']['cost'])               # USD per year
+```
+
+`ies-optimiser --help` lists the commands; `ies-optimiser schema input` prints the JSON Schema of an input.
+
+## Licence and data
+
+The code, the thermodynamics sources and the synthetic examples are under the MIT licence. The illustrative datasets in [`datasets/`](https://github.com/greoux-research/ies-optimiser/tree/main/datasets) are not part of the installed package: their hourly profiles are derived from Renewables.ninja and licensed CC BY-NC 4.0.
+
+Report problems at https://github.com/greoux-research/ies-optimiser/issues.
+
+## Repository
+
+- **src/ies_optimiser** — the package: the API, the input and result models, their JSON Schemas, the command line, and the model; **thermo** — the C++ thermodynamics sources, built into the package by CMake; **ies_optimiser.py** — a launcher for `python ies_optimiser.py ...` in a checkout.
+- **examples** — the synthetic cases; **datasets** — four illustrative island cases (`tools/build_datasets.py`); **results** — the current verified results for them, with provenance.
+- **tests** — the development suite; **tests_installed** — the tests CI runs against each built wheel, outside the checkout; **tools** — builders, the result comparator, distribution and native-executable checks, the scenario runner (writing to the ignored **runs** folder) and `product_costs.py` (IES Optimiser's product cost KPI is an allocation, not a production cost).
+
+Every result carries a `provenance` block recording the code, the digests of the input and of each profile it references, the options applied, and the solver and environment that produced it, and a `system.checks` block recording whether its balances and accounts reconcile. Results are reproducible only against a recorded environment: a different solver build may settle on a different vertex of the same optimal face, so hourly dispatch and surplus can differ between equally optimal results.
+
+## How to cite IES Optimiser
+
+Gréoux Research (2024). IES Optimiser: a linear optimiser-based integrated energy system modelling environment. https://github.com/greoux-research/ies-optimiser

ies_optimiser-2026.9.0/README.md

@@ -0,0 +1,65 @@
+# IES Optimiser
+
+IES Optimiser (*Integrated Energy Systems Optimiser*) is a linear optimiser-based energy system modelling environment designed to support initial investigations such as options evaluation and trend analysis. It sizes and dispatches generators, storage and Power-to-X processes (electrolysis, desalination, cogeneration heat) over a year of hourly steps, with OR-Tools' GLOP solver.
+
+- [Modelling Approach](https://github.com/greoux-research/ies-optimiser/blob/main/docs/ies-optimiser-modelling-approach.md)
+- [Setup Guide](https://github.com/greoux-research/ies-optimiser/blob/main/docs/ies-optimiser-setup-guide.md)
+- [IO File Structure](https://github.com/greoux-research/ies-optimiser/blob/main/docs/ies-optimiser-io-file-structure.md)
+- [Inputs, Validation and the Python API](https://github.com/greoux-research/ies-optimiser/blob/main/docs/ies-optimiser-api.md)
+- [Supported Platforms](https://github.com/greoux-research/ies-optimiser/blob/main/docs/support-matrix.md)
+- [Changelog](https://github.com/greoux-research/ies-optimiser/blob/main/CHANGELOG.md)
+- [Baseline Verification](https://github.com/greoux-research/ies-optimiser/blob/main/docs/baseline-verification.md)
+
+## Installation
+
+IES Optimiser needs Python 3.11 or later, on Linux x86_64 (glibc 2.28+), macOS (Apple Silicon 11+, Intel 10.15+) or Windows x86_64. Wheels include the compiled thermodynamics executable; no compiler is needed.
+
+Install it from PyPI into a fresh virtual environment:
+
+```bash
+python3 -m venv ies-optimiser-env
+source ies-optimiser-env/bin/activate          # Windows: ies-optimiser-env\Scripts\activate
+python -m pip install ies-optimiser
+```
+
+To install a wheel file or a development checkout instead, see the [Setup Guide](https://github.com/greoux-research/ies-optimiser/blob/main/docs/ies-optimiser-setup-guide.md).
+
+## Use
+
+A synthetic demonstration case (a solar, gas and battery system; MIT-licensed, like the code) is in the repository's [`examples/`](https://github.com/greoux-research/ies-optimiser/tree/main/examples) folder, with a thermally coupled Power-to-X case beside it; `python tools/build_examples.py` regenerates both in a checkout. From a directory holding a copy of `examples/`:
+
+<!-- tested -->
+```bash
+ies-optimiser validate examples/electricity-storage/case.json      # check without solving
+ies-optimiser examples/electricity-storage/case.json carbon-constraint=150
+# -> examples/electricity-storage/case.ies-optimiser.carbon-constraint_150.0.json
+```
+
+<!-- tested -->
+```python
+import ies_optimiser
+
+result = ies_optimiser.solve('examples/power-to-x-thermal/case.json')
+if result.optimal and result.accounting_ok:
+    print(result.document['system']['cost'])               # USD per year
+```
+
+`ies-optimiser --help` lists the commands; `ies-optimiser schema input` prints the JSON Schema of an input.
+
+## Licence and data
+
+The code, the thermodynamics sources and the synthetic examples are under the MIT licence. The illustrative datasets in [`datasets/`](https://github.com/greoux-research/ies-optimiser/tree/main/datasets) are not part of the installed package: their hourly profiles are derived from Renewables.ninja and licensed CC BY-NC 4.0.
+
+Report problems at https://github.com/greoux-research/ies-optimiser/issues.
+
+## Repository
+
+- **src/ies_optimiser** — the package: the API, the input and result models, their JSON Schemas, the command line, and the model; **thermo** — the C++ thermodynamics sources, built into the package by CMake; **ies_optimiser.py** — a launcher for `python ies_optimiser.py ...` in a checkout.
+- **examples** — the synthetic cases; **datasets** — four illustrative island cases (`tools/build_datasets.py`); **results** — the current verified results for them, with provenance.
+- **tests** — the development suite; **tests_installed** — the tests CI runs against each built wheel, outside the checkout; **tools** — builders, the result comparator, distribution and native-executable checks, the scenario runner (writing to the ignored **runs** folder) and `product_costs.py` (IES Optimiser's product cost KPI is an allocation, not a production cost).
+
+Every result carries a `provenance` block recording the code, the digests of the input and of each profile it references, the options applied, and the solver and environment that produced it, and a `system.checks` block recording whether its balances and accounts reconcile. Results are reproducible only against a recorded environment: a different solver build may settle on a different vertex of the same optimal face, so hourly dispatch and surplus can differ between equally optimal results.
+
+## How to cite IES Optimiser
+
+Gréoux Research (2024). IES Optimiser: a linear optimiser-based integrated energy system modelling environment. https://github.com/greoux-research/ies-optimiser

ies_optimiser-2026.9.0/pyproject.toml

@@ -0,0 +1,192 @@
+[build-system]
+# scikit-build-core drives CMake, which builds the thermodynamics executable
+# (thermo/*.cpp) into the wheel. 0.11 is the first release with PEP 639
+# licence metadata.
+requires = ["scikit-build-core>=0.11"]
+build-backend = "scikit_build_core.build"
+
+[project]
+name = "ies-optimiser"
+# The single authoritative version (calendar versioning: year.month.patch).
+# Installed code reads it from the distribution metadata (ies_optimiser.__version__).
+version = "2026.9.0"
+description = "IES Optimiser: a linear optimiser-based integrated energy system modelling environment"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "Gréoux Research" }]
+# The minimum. Verified locally on macOS arm64 with 3.11, 3.12, 3.13 and 3.14;
+# the full platform matrix (docs/support-matrix.md) is verified by CI.
+requires-python = ">=3.11"
+# Ranges follow what the code imports and what has been verified:
+#  - numpy: array handling and profile I/O; written against the NumPy 2 API,
+#    verified with 2.0.2.
+#  - ortools: GLOP through ortools.linear_solver.pywraplp and the version query
+#    in ortools.init. Verified with 9.15.6755. The solver build decides which
+#    optimal vertex is returned, so results are reproducible only against a
+#    recorded version; the range is not a claim that every 9.x gives the same
+#    dispatch, and releases before 9.15 are not tested.
+#  - pydantic: the input and result models; validate_by_name and
+#    serialize_by_alias need 2.11.
+dependencies = [
+    "numpy>=2.0,<3",
+    "ortools>=9.15,<10",
+    "pydantic>=2.11,<3",
+]
+keywords = ["energy system", "optimisation", "linear programming", "power-to-x", "cogeneration"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Science/Research",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: C++",
+    "Operating System :: MacOS",
+    "Operating System :: POSIX :: Linux",
+    "Operating System :: Microsoft :: Windows",
+    "Topic :: Scientific/Engineering",
+    "Typing :: Typed",
+]
+
+[project.optional-dependencies]
+# pip install -e ".[dev]": the test suite, the schema tests and the type check.
+dev = [
+    "pytest>=8",
+    "jsonschema>=4.18",
+    "mypy>=1.10",
+    "build>=1.2",
+]
+
+[project.scripts]
+ies-optimiser = "ies_optimiser.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/greoux-research/ies-optimiser"
+Documentation = "https://github.com/greoux-research/ies-optimiser/tree/main/docs"
+Source = "https://github.com/greoux-research/ies-optimiser"
+Issues = "https://github.com/greoux-research/ies-optimiser/issues"
+Changelog = "https://github.com/greoux-research/ies-optimiser/blob/main/CHANGELOG.md"
+
+[tool.scikit-build]
+minimum-version = "build-system.requires"
+build-dir = "build/{wheel_tag}"
+cmake.version = ">=3.15"
+# The wheel carries a native executable but no Python extension: it is tagged
+# py3-none-<platform>, installable on any Python 3 of that platform, and never
+# as a pure-Python (any) wheel.
+wheel.py-api = "py3"
+wheel.packages = ["src/ies_optimiser"]
+# ies_optimiser/_bin/ies-optimiser-thermo comes from the CMake install step. src/ies_optimiser/_bin is
+# ignored by Git and excluded from the sdist, and a clean build tree holds none.
+# The source distribution is an allow-list: the package, the native sources
+# and their build files, the metadata. Datasets (whose profiles are licensed
+# CC BY-NC 4.0), results, runs, tests, tools, docs and build products are
+# excluded.
+sdist.exclude = ["/*"]
+sdist.include = [
+    "/pyproject.toml",
+    "/CMakeLists.txt",
+    "/README.md",
+    "/LICENSE",
+    "/src/ies_optimiser/*.py",
+    "/src/ies_optimiser/py.typed",
+    "/src/ies_optimiser/data/*.schema.json",
+    "/thermo/*.cpp",
+    "/thermo/*.h",
+    "/thermo/README.md",
+]
+
+# Cross-platform wheels (.github/workflows/wheels.yml runs cibuildwheel with
+# this configuration; docs/support-matrix.md explains the choices).
+#
+# The wheel is py3-none-<platform>: one wheel per platform serves every
+# supported Python, so it is built once, with CPython 3.11 (the minimum), and
+# the CI test jobs install it on each supported Python. The repair step checks
+# the thermodynamics executable itself (tools/inspect_native.py), since the
+# repair tools are written for extension modules.
+[tool.cibuildwheel]
+build = "cp311-*"
+skip = "*-musllinux_*"
+build-frontend = "build"
+build-verbosity = 1
+before-build = "python -m pip install pyelftools pefile auditwheel"
+test-requires = ["pytest", "jsonschema"]
+test-sources = [
+    "tests_installed", "tests/fixtures", "examples", "README.md", "docs/ies-optimiser-api.md", "docs/ies-optimiser-setup-guide.md",
+    "tools/check_invariants.py",
+]
+test-command = "python -m pytest tests_installed -p no:cacheprovider -q -rs"
+
+[tool.cibuildwheel.linux]
+# glibc 2.28 and later (RHEL 8, Debian 10, Ubuntu 18.10 and newer), the same
+# baseline as the OR-Tools wheels IES Optimiser depends on.
+archs = ["x86_64"]
+manylinux-x86_64-image = "manylinux_2_28"
+repair-wheel-command = [
+    "auditwheel repair --plat manylinux_2_28_x86_64 -w {dest_dir} {wheel}",
+    "python {project}/tools/inspect_native.py {dest_dir}",
+]
+
+[tool.cibuildwheel.macos]
+archs = ["native"]
+repair-wheel-command = [
+    "delocate-wheel --require-archs {delocate_archs} -w {dest_dir} -v {wheel}",
+    "python {project}/tools/inspect_native.py {dest_dir}",
+]
+
+[tool.cibuildwheel.windows]
+archs = ["AMD64"]
+# No DLL to bundle (the C++ runtime is linked statically): check, then copy.
+repair-wheel-command = "python {project}/tools/inspect_native.py {wheel} --copy-to {dest_dir}"
+
+# Minimum macOS: the floor of the OR-Tools wheels for each architecture.
+[[tool.cibuildwheel.overrides]]
+select = "*-macosx_arm64"
+environment = { MACOSX_DEPLOYMENT_TARGET = "11.0" }
+
+[[tool.cibuildwheel.overrides]]
+select = "*-macosx_x86_64"
+environment = { MACOSX_DEPLOYMENT_TARGET = "10.15" }
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+# Static type checking of the public boundary:  python -m mypy
+# Scope: the modules users and scripts call. The model-building modules are
+# imported and followed silently (their errors are not reported here) and are
+# typed incrementally; chk's functions and the fcn functions the boundary calls
+# are annotated already.
+[tool.mypy]
+# No python_version: mypy checks against the interpreter it runs in, whose
+# installed NumPy stubs may use syntax newer than 3.11 (NumPy 2.5 requires
+# 3.12). Compatibility with 3.11 itself is tested by running on 3.11.
+files = [
+    "src/ies_optimiser/__init__.py", "src/ies_optimiser/__main__.py", "src/ies_optimiser/_install.py", "src/ies_optimiser/api.py",
+    "src/ies_optimiser/cli.py", "src/ies_optimiser/errors.py", "src/ies_optimiser/formats.py", "src/ies_optimiser/models.py",
+    "src/ies_optimiser/results.py", "src/ies_optimiser/schemas.py",
+]
+mypy_path = "src"
+plugins = ["pydantic.mypy"]
+strict = true
+# Calls from the boundary into the equation-building modules are allowed while
+# those remain unannotated.
+untyped_calls_exclude = [
+    "ies_optimiser.eqs_dmd_e", "ies_optimiser.eqs_dmd_x", "ies_optimiser.eqs_flx", "ies_optimiser.eqs_gen", "ies_optimiser.eqs_p2x_1", "ies_optimiser.eqs_p2x_2",
+    "ies_optimiser.obj", "ies_optimiser.opt", "ies_optimiser.pos",
+]
+
+[[tool.mypy.overrides]]
+module = [
+    "ies_optimiser.chk", "ies_optimiser.fcn", "ies_optimiser.eqs_dmd_e", "ies_optimiser.eqs_dmd_x", "ies_optimiser.eqs_flx", "ies_optimiser.eqs_gen", "ies_optimiser.eqs_p2x_1",
+    "ies_optimiser.eqs_p2x_2", "ies_optimiser.obj", "ies_optimiser.opt", "ies_optimiser.pos", "ies_optimiser.pos_dmd",
+]
+follow_imports = "silent"
+
+[[tool.mypy.overrides]]
+module = ["ortools.*"]
+ignore_missing_imports = true
+
+[tool.pydantic-mypy]
+init_forbid_extra = true
+init_typed = true
+warn_required_dynamic_aliases = true

ies_optimiser-2026.9.0/src/ies_optimiser/__init__.py

@@ -0,0 +1,37 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+# Gréoux Research (2024). IES Optimiser: a linear optimiser-based integrated energy system modelling environment. https://github.com/greoux-research/ies-optimiser
+
+"""IES Optimiser: a linear optimiser-based integrated energy system modelling environment.
+
+    import ies_optimiser
+
+    report = ies_optimiser.validate('case.json')              # nothing solved, nothing written
+    result = ies_optimiser.solve('case.json', options={'carbon-constraint': 50.0})
+    if result.optimal and result.accounting_ok:
+        print(result.document['system']['cost'])
+
+The names below are the public API; see docs/ies-optimiser-api.md. The public modules
+are ies_optimiser.api, ies_optimiser.models, ies_optimiser.results, ies_optimiser.errors, ies_optimiser.schemas and
+ies_optimiser.cli. The modelling modules (chk, fcn, eqs_*, obj, opt, pos, pos_dmd,
+formats) are internal, except for fcn.RunConfig, exported here. Importing ies_optimiser
+reads, writes, prints and runs nothing.
+"""
+
+from ies_optimiser._install import version as _version
+from ies_optimiser.api import (SolveResult, ValidationReport, check_options, load_input, output_path, parse_case, solve,
+                               to_canonical, validate, write_result)
+from ies_optimiser.errors import Diagnostic, IesOptimiserError, InputError, ThermoError
+from ies_optimiser.fcn import RunConfig
+from ies_optimiser.models import (Case, CommodityDemand, Demand, ElectricityDemand, Generator, Process, SolveOptions,
+                                  Storage)
+
+__version__: str = _version()
+
+__all__ = [
+    '__version__',
+    'solve', 'validate', 'load_input', 'parse_case', 'to_canonical', 'check_options', 'write_result',
+    'output_path', 'SolveResult', 'ValidationReport', 'RunConfig',
+    'IesOptimiserError', 'InputError', 'ThermoError', 'Diagnostic',
+    'Case', 'Demand', 'ElectricityDemand', 'CommodityDemand', 'Generator', 'Storage', 'Process', 'SolveOptions',
+]

ies_optimiser-2026.9.0/src/ies_optimiser/__main__.py

@@ -0,0 +1,10 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+# Gréoux Research (2024). IES Optimiser: a linear optimiser-based integrated energy system modelling environment. https://github.com/greoux-research/ies-optimiser
+
+"""python -m ies_optimiser ...: the same command line as the ies-optimiser console command."""
+
+from ies_optimiser.cli import main
+
+if __name__ == '__main__':
+    raise SystemExit(main())

ies_optimiser-2026.9.0/src/ies_optimiser/_install.py

@@ -0,0 +1,132 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+# Gréoux Research (2024). IES Optimiser: a linear optimiser-based integrated energy system modelling environment. https://github.com/greoux-research/ies-optimiser
+
+"""Where this copy of IES Optimiser lives: its version, its files, its checkout (if
+any) and its thermodynamics executable.
+
+Nothing here reads outside the package's own directory and its distribution
+metadata, and nothing is written, downloaded or compiled. The version comes
+from the installed distribution's metadata, which pyproject.toml sets (the
+single authoritative version); a source tree that is not installed reads
+pyproject.toml itself.
+"""
+
+import os
+import sys
+from importlib import metadata, resources
+from typing import Any, Dict, Optional
+
+DISTRIBUTION = 'ies-optimiser'
+
+PACKAGE_DIR = os.path.dirname(os.path.abspath(__file__))
+"""The directory of the ies_optimiser package that is running (site-packages/ies_optimiser, or src/ies_optimiser)."""
+
+THERMO_NAME = 'ies-optimiser-thermo.exe' if sys.platform == 'win32' else 'ies-optimiser-thermo'
+"""The thermodynamics executable's file name on this platform."""
+
+
+def packaged_thermo() -> str:
+    """The absolute path of the thermodynamics executable installed with the
+    package, whether or not it exists; never looked up in the working
+    directory or a repository.
+
+    A wheel installs it beside the modules, at ies_optimiser/_bin/, found through the
+    package's resources. An editable install keeps the modules in the source
+    tree and the built executable in site-packages; there it is the file the
+    distribution records as ies_optimiser/_bin/<name> (its RECORD), and only when the
+    distribution is an editable install of the running checkout.
+    """
+    beside = os.path.abspath(str(resources.files('ies_optimiser').joinpath('_bin', THERMO_NAME)))
+    if os.path.isfile(beside):
+        return beside
+    root = checkout_root()
+    dist = _distribution()
+    if root is not None and dist is not None and _editable_of(dist, root):
+        wanted = '/'.join(('ies_optimiser', '_bin', THERMO_NAME))
+        for entry in dist.files or ():
+            if str(entry).replace(os.sep, '/') == wanted:
+                return os.path.abspath(str(dist.locate_file(entry)))
+    return beside
+
+
+def checkout_root() -> Optional[str]:
+    """The source checkout this package is running from -- the directory
+    holding pyproject.toml above src/ies_optimiser -- or None for an installed wheel."""
+    src = os.path.dirname(PACKAGE_DIR)
+    root = os.path.dirname(src)
+    if os.path.basename(PACKAGE_DIR) == 'ies_optimiser' and os.path.basename(src) == 'src' \
+            and os.path.isfile(os.path.join(root, 'pyproject.toml')):
+        return root
+    return None
+
+
+def _distribution() -> Optional[metadata.Distribution]:
+    try:
+        return metadata.distribution(DISTRIBUTION)
+    except metadata.PackageNotFoundError:
+        return None
+
+
+def _same(a: str, b: str) -> bool:
+    try:
+        return os.path.samefile(a, b)
+    except OSError:
+        return False
+
+
+def installation() -> Dict[str, Any]:
+    """How the running package was installed.
+
+    Returns
+    -------
+    dict
+        ``kind``: 'wheel' (an installed distribution whose files are the
+        running ones), 'editable' (an editable install of the running
+        checkout), 'source' (a checkout on the path but not installed) or
+        'unknown'; ``version``; ``package_dir``; ``checkout`` (the source
+        checkout's root, or None).
+    """
+    root = checkout_root()
+    dist = _distribution()
+    kind = 'unknown'
+    version = None
+    if dist is not None:
+        installed = dist.locate_file(os.path.join('ies_optimiser', '__init__.py'))
+        if _same(str(installed), os.path.join(PACKAGE_DIR, '__init__.py')):
+            kind, version = 'wheel', dist.version
+        elif root is not None and _editable_of(dist, root):
+            kind, version = 'editable', dist.version
+    if kind == 'unknown' and root is not None:
+        kind, version = 'source', _pyproject_version(root)
+    return {'kind': kind, 'version': version, 'package_dir': PACKAGE_DIR, 'checkout': root}
+
+
+def _editable_of(dist: metadata.Distribution, root: str) -> bool:
+    # PEP 610: an editable install records the project directory it points to.
+    import json
+    from urllib.parse import urlparse
+    from urllib.request import url2pathname
+    text = dist.read_text('direct_url.json')
+    if not text:
+        return False
+    info = json.loads(text)
+    if not info.get('dir_info', {}).get('editable'):
+        return False
+    url = urlparse(info.get('url', ''))
+    # url2pathname turns '/C:/dir' into 'C:\\dir' on Windows and unquotes.
+    return url.scheme == 'file' and _same(url2pathname(url.path), root)
+
+
+def _pyproject_version(root: str) -> Optional[str]:
+    try:
+        import tomllib
+        with open(os.path.join(root, 'pyproject.toml'), 'rb') as f:
+            return str(tomllib.load(f)['project']['version'])
+    except (ImportError, OSError, KeyError, ValueError):
+        return None
+
+
+def version() -> str:
+    """The version of the running package ('unknown' if it cannot be told)."""
+    return installation()['version'] or 'unknown'