Feature: public methods to interface with new backend model instance (#…

…471) * Split BackendModel ABC for latex backend * Move backend API away from Model object * Add param updater, variable fixer/unfixer * Store input dataset in backend * Reorganise files; add backend updater funcs * update api docs --------- Co-authored-by: Stefan Pfenninger <[email protected]>
calliope-project · Oct 23, 2023 · 42500c7 · 42500c7
1 parent 5591b09
commit 42500c7
Show file tree

Hide file tree

Showing 25 changed files with 2,120 additions and 1,782 deletions.
diff --git a/doc/api/api.rst b/doc/api/api.rst
@@ -33,6 +33,15 @@ Time series
 .. automodule:: calliope.time.funcs
     :members: resample
 
+.. _api_backend_interface:
+
+Methods to interface with the optimisation problem (a.k.a., `backend`)
+======================================================================
+
+.. autoclass:: calliope.backend.backend_model.BackendModel
+    :members:
+    :inherited-members:
+
 .. _api_utility_classes:
 
 Utility classes: AttrDict, Exceptions, Logging

diff --git a/doc/user/troubleshooting.rst b/doc/user/troubleshooting.rst
@@ -20,7 +20,8 @@ General strategies
 
   .. code-block:: python
 
-    model.to_lp('my_saved_model.lp')
+    model.build()
+    model.backend.to_lp('my_saved_model.lp')
 
 Improving solution times
 ------------------------