Release v0.7.0.dev6 (#746)

* Release v0.7.0.dev6
* Make gurobi class attr conditional on gurobipy existing, to enable pypi builds

Author: brynpickering

.github/workflows/commit-ci.yml

@@ -44,9 +44,9 @@ jobs:
     - name: Install jupyter kernel
       run: python -m ipykernel install --user --name calliope
 
-    - name: run tests without coverage
+    - name: run tests without coverage and without time intensive tests
       if: github.ref != 'refs/heads/main'
-      run: pytest
+      run: pytest --no-cov -m 'not time_intensive' -m 'not needs_gurobi_license'
 
     - name: run tests with coverage
       if: github.ref == 'refs/heads/main'

.github/workflows/pr-ci.yml

@@ -69,7 +69,7 @@ jobs:
 
     - name: run tests without coverage
       if: matrix.os != 'ubuntu-latest' || matrix.py3version != '12'
-      run: pytest
+      run: pytest --no-cov
 
     - name: Upload coverage reports to Codecov
       uses: codecov/codecov-action@v4

CHANGELOG.md

@@ -1,22 +1,38 @@
-## 0.7.0.dev6
+## 0.7.0.dev6 (2025-03-24)
 
 ### User-facing changes
 
-|new| working SPORES mode, upgraded from v0.6 to include a selection of scoring algorithms.
+|new| working SPORES mode, upgraded from v0.6 to include a selection of scoring algorithms (#716).
 
-|new| backend `set_objective` method, to switch between pre-defined objectives.
+|new| backend `set_objective` method, to switch between pre-defined objectives (#716).
 
-|changed| coin-or-cbc is now available cross-platform on conda-forge and so is the recommended open-source solver to install a user environment with.
+|changed| |backwards-incompatible| `from` and `to` parameters (to define start and end point of a transmission link) are now `link_from` and `link_to` (#717).
 
-|changed| Upper bound pins for dependencies removed where possible, to minimise clashes when using calliope as a dependency in a project.
+|changed| |backwards-incompatible| `operate` and `spores` mode configuration options are now nested within the main configuration (e.g., `build.operate_window` is now `build.operate.window` and `solve.spores_number` is now `solve.spores.number`) (#704).
 
-## 0.7.0.dev5 (2024-12-04)
+|changed| coin-or-cbc is now available cross-platform on conda-forge and so is the recommended open-source solver to install a user environment with (#744).
 
-### User-facing changes
+|changed| Upper bound pins for dependencies removed where possible, to minimise clashes when using calliope as a dependency in a project (#744).
+
+|changed| |backwards-incompatible| to ensure the model configuration always remains in sync with the results, `kwargs` in `model.build()` and `model.solve()` now directly affect `model.config` (#704)
+
+|changed| `template:` can now be used anywhere within YAML definition files, not just in the `nodes`, `techs` and `data_tables` sections (#719).
+
+|changed| Removed `inheritance` math helper function since we use `base_tech` for abstract base technologies and templates are now applied too early to be available later (#719).
+To refer to template inheritance, set a parameter within a template as all children will share the same value.
+
+### Internal changes
+
+|changed| Moved to using `pydantic` to document and validate our configuration, rather than JSON schema (#704, #717).
+
+|changed| As with base dependencies, moved to pinning lower bound only for development dependencies (#744).
 
-|changed| to ensure the model configuration always remains in sync with the results, `kwargs` in `model.build()` and `model.solve()` now directly affect `model.config`
+|changed| Curtailed `calliope.AttrDict` relevance, with I/O moved to `calliope.io` and attribute access moved to `pydantic` models.
+`AttrDict` is still used to merge overrides and templates into the model definition dictionary, before creating the `pydantic` models.
 
-|changed| `template:` can now be used anywhere within YAML definition files, not just in the `nodes`, `techs` and `data_tables` sections.
+## 0.7.0.dev5 (2024-12-04)
+
+### User-facing changes
 
 |changed| "An overview of the Calliope terminology" information admonition to remove self-references and improve understandability.
 Now also includes a visual depiction of how the different defined components connect together (#699).

src/calliope/_version.py

@@ -1 +1 @@
-__version__ = "0.7.0.dev5"
+__version__ = "0.7.0.dev6"

src/calliope/backend/__init__.py

@@ -9,7 +9,6 @@
     ALLOWED_MATH_FILE_FORMATS,
     LatexBackendModel,
 )
-from calliope.backend.parsing import ParsedBackendComponent
 from calliope.backend.pyomo_backend_model import PyomoBackendModel
 from calliope.exceptions import BackendError
 from calliope.preprocess import CalliopeMath

src/calliope/backend/gurobi_backend_model.py

@@ -42,12 +42,22 @@
 class GurobiBackendModel(backend_model.BackendModel):
     """gurobipy-specific backend functionality."""
 
-    OBJECTIVE_SENSE_DICT = {
-        "minimize": gurobipy.GRB.MINIMIZE,
-        "minimise": gurobipy.GRB.MINIMIZE,
-        "maximize": gurobipy.GRB.MAXIMIZE,
-        "maximise": gurobipy.GRB.MAXIMIZE,
-    }
+    OBJECTIVE_SENSE_DICT: dict[str, int]
+    if importlib.util.find_spec("gurobipy") is not None:
+        OBJECTIVE_SENSE_DICT = {
+            "minimize": gurobipy.GRB.MINIMIZE,
+            "minimise": gurobipy.GRB.MINIMIZE,
+            "maximize": gurobipy.GRB.MAXIMIZE,
+            "maximise": gurobipy.GRB.MAXIMIZE,
+        }
+    else:
+        # As of Gurobi v11, these are the correct integer values for the above constants
+        OBJECTIVE_SENSE_DICT = {
+            "minimize": 1,
+            "minimise": 1,
+            "maximize": -1,
+            "maximise": -1,
+        }
 
     def __init__(
         self, inputs: xr.Dataset, math: CalliopeMath, build_config: config_schema.Build

tests/test_backend_general.py

@@ -6,6 +6,7 @@
 import xarray as xr
 
 import calliope
+import calliope.backend
 
 from .common.util import build_test_model as build_model
 from .common.util import check_error_or_warning

tests/test_example_models.py

@@ -71,8 +71,7 @@ def _example_tester(solver="cbc", solver_io=None):
             model = request.getfixturevalue(request.param)
 
             solve_kwargs = {"solver": solver}
-            if solver_io:
-                solve_kwargs["solver_io"] = solver_io
+            solve_kwargs["solver_io"] = solver_io
 
             model.solve(force=True, **solve_kwargs)
 
@@ -480,6 +479,7 @@ def test_milp_example_results(self):
 
         assert float(model.results.cost.sum()) == approx(540.780779)
 
+    @pytest.mark.time_intensive
     def test_operate_example_results(self):
         model = calliope.examples.operate(time_subset=["2005-07-01", "2005-07-04"])