Oetc support (refactored) (#487)

* Implement OETC authentication step

* Implement cloud provider credentials fetch

* Implement OETC model compression and upload

* Implement job submission to oetc

* Implement waiting for OETC job completion

* Implement solution download and decompression

* Add proper logging

* Add oetc call to linopy model

* Add requests dependency

* Fix wrong orchestrator endpoint values

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Fix type hint error caught by mypy

* Fix conflicts

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Add OETC integration entry in the release notes

* Ignore false positive type warning

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Extend logging for oetc processes

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Use remote argument instead of oetc_settings

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Fix mypy errors

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update solve method docs

* fix: missing import of RemoteHandler

* refac: use remote dir and move stuff there

* feat: increase test coverage

* add type hints

---------

Co-authored-by: Kristijan Faust <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: 3 people

.gitignore

@@ -14,11 +14,14 @@ doc/_build
 doc/generated
 doc/api
 .vscode
+.idea
 Highs.log
 paper/
 monkeytype.sqlite3
 .github/copilot-instructions.md
 uv.lock
+*.pyc
+
 
 # Environments
 .env

doc/release_notes.rst

@@ -10,6 +10,7 @@ Version 0.5.6
 
 * Improved variable/expression arithmetic methods so that they correctly handle types
 * Gurobi: Pass dictionary as env argument `env={...}` through to gurobi env creation
+* Added integration with OETC platform
 * Mosek: Remove explicit use of Env, use global env instead
 * Objectives can now be created from variables via `linopy.Model.add_objective`.
 

linopy/__init__.py

@@ -20,7 +20,7 @@
 from linopy.io import read_netcdf
 from linopy.model import Model, Variable, Variables, available_solvers
 from linopy.objective import Objective
-from linopy.remote import RemoteHandler
+from linopy.remote import OetcHandler, RemoteHandler
 
 __all__ = (
     "Constraint",
@@ -31,6 +31,7 @@
     "LinearExpression",
     "Model",
     "Objective",
+    "OetcHandler",
     "QuadraticExpression",
     "RemoteHandler",
     "Variable",

linopy/model.py

@@ -58,6 +58,7 @@
 )
 from linopy.matrices import MatrixAccessor
 from linopy.objective import Objective
+from linopy.remote import OetcHandler, RemoteHandler
 from linopy.solvers import IO_APIS, available_solvers, quadratic_solvers
 from linopy.types import (
     ConstantLike,
@@ -1050,7 +1051,7 @@ def solve(
         sanitize_zeros: bool = True,
         sanitize_infinities: bool = True,
         slice_size: int = 2_000_000,
-        remote: Any = None,
+        remote: RemoteHandler | OetcHandler = None,  # type: ignore
         progress: bool | None = None,
         **solver_options: Any,
     ) -> tuple[str, str]:
@@ -1111,7 +1112,7 @@ def solve(
             Size of the slice to use for writing the lp file. The slice size
             is used to split large variables and constraints into smaller
             chunks to avoid memory issues. The default is 2_000_000.
-        remote : linopy.remote.RemoteHandler
+        remote : linopy.remote.RemoteHandler | linopy.oetc.OetcHandler, optional
             Remote handler to use for solving model on a server. Note that when
             solving on a rSee
             linopy.remote.RemoteHandler for more details.
@@ -1137,20 +1138,23 @@ def solve(
                 f"Keyword argument `io_api` has to be one of {IO_APIS} or None"
             )
 
-        if remote:
-            solved = remote.solve_on_remote(
-                self,
-                solver_name=solver_name,
-                io_api=io_api,
-                problem_fn=problem_fn,
-                solution_fn=solution_fn,
-                log_fn=log_fn,
-                basis_fn=basis_fn,
-                warmstart_fn=warmstart_fn,
-                keep_files=keep_files,
-                sanitize_zeros=sanitize_zeros,
-                **solver_options,
-            )
+        if remote is not None:
+            if isinstance(remote, OetcHandler):
+                solved = remote.solve_on_oetc(self)
+            else:
+                solved = remote.solve_on_remote(
+                    self,
+                    solver_name=solver_name,
+                    io_api=io_api,
+                    problem_fn=problem_fn,
+                    solution_fn=solution_fn,
+                    log_fn=log_fn,
+                    basis_fn=basis_fn,
+                    warmstart_fn=warmstart_fn,
+                    keep_files=keep_files,
+                    sanitize_zeros=sanitize_zeros,
+                    **solver_options,
+                )
 
             self.objective.set_value(solved.objective.value)
             self.status = solved.status

linopy/remote/__init__.py

@@ -0,0 +1,19 @@
+"""
+Remote execution handlers for linopy models.
+
+This module provides different handlers for executing optimization models
+on remote systems:
+
+- RemoteHandler: SSH-based remote execution using paramiko
+- OetcHandler: Cloud-based execution via OET Cloud service
+"""
+
+from linopy.remote.oetc import OetcCredentials, OetcHandler, OetcSettings
+from linopy.remote.ssh import RemoteHandler
+
+__all__ = [
+    "RemoteHandler",
+    "OetcHandler",
+    "OetcSettings",
+    "OetcCredentials",
+]