Merge branch 'master' into olivierjuan/master

Author: lkstrp

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -0,0 +1,67 @@
+name: Bug Report
+description: Create a report if something doesn't work quite right.
+labels: ["bug", "needs triage"]
+
+body:
+- type: markdown
+  attributes:
+    value: |
+      Thanks for taking the time to fill out this bug report!
+
+- type: checkboxes
+  id: checks
+  attributes:
+    label: Version Checks (indicate both or one)
+    options:
+    - label: >
+        I have confirmed this bug exists on the lastest
+        [release](https://github.com/pypsa/linopy/releases) of Linopy.
+    - label: >
+        I have confirmed this bug exists on the current
+        [`master`](https://github.com/pypsa/linopy/tree/master) branch of Linopy.
+
+- type: textarea
+  id: problem
+  attributes:
+    label: Issue Description
+    description: >
+      Please provide a description of the issue.
+  validations:
+    required: true
+
+- type: textarea
+  id: example
+  validations:
+    required: true
+  attributes:
+    label: Reproducible Example
+    description: >
+      Please provide a minimal reproduciable example. See how to [craft minimal bug reports](https://matthewrocklin.com/minimal-bug-reports).
+    placeholder: >
+      from linopy import Model
+
+      m = Model()
+
+    render: python
+
+- type: textarea
+  id: expected-behavior
+  validations:
+    required: true
+  attributes:
+    label: Expected Behavior
+    description: >
+      Please describe or show a code example of the expected behavior.
+
+- type: textarea
+  id: version
+  attributes:
+    label: Installed Versions
+    description: >
+      Please share information on your environment. Paste the output below.  For conda ``conda env export`` and for pip ``pip freeze``.
+    value: >
+      <details>
+
+      Replace this line.
+
+      </details>

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: true

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,13 @@
+---
+name: Feature Request
+about: Suggest an idea for this project
+title: ''
+labels: ["feature", "needs triage"]
+assignees: ''
+
+---
+
+## Describe the feature you'd like to see
+
+*Please give a clear and concise description and provide context why the feature would be useful.*
+*Also, we'd appreciate any implementation ideas and references you already have.*

.github/pull_request_template.md

@@ -0,0 +1,11 @@
+Closes # (if applicable).
+
+## Changes proposed in this Pull Request
+
+
+## Checklist
+
+- [ ] Code changes are sufficiently documented; i.e. new functions contain docstrings and further explanations may be given in `doc`.
+- [ ] Unit tests for new features were added (if applicable).
+- [ ] A note for the release notes `doc/release_notes.rst` of the upcoming release is included.
+- [ ] I consent to the release of this PR's code under the MIT license.

.github/workflows/test-models.yml

@@ -0,0 +1,111 @@
+name: Test models
+
+on:
+  push:
+    branches:
+    - master
+  pull_request:
+    branches:
+    - master
+  schedule:
+  - cron: "0 5 * * *"
+
+# Cancel any in-progress runs when a new run is triggered
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test-pypsa-eur:
+    name: PyPSA-Eur
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        version:
+        - master
+        # - latest # Activate when v0.14.0 is released
+
+    defaults:
+      run:
+        shell: bash -l {0}
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        repository: PyPSA/pypsa-eur
+        ref: master
+
+    - name: Check out latest release
+      if: matrix.version == 'latest'
+      run: |
+        git fetch --tags
+        latest_tag=$(git describe --tags `git rev-list --tags --max-count=1`)
+        git checkout $latest_tag
+
+    # Only run check if package is not pinned
+    - name: Check if inhouse package is pinned
+      run: |
+        grep_line=$(grep -- '- pypsa' envs/environment.yaml)
+        if [[ $grep_line == *"<"* || $grep_line == *"=="* ]]; then
+            echo "pinned=true" >> $GITHUB_ENV
+        else
+            echo "pinned=false" >> $GITHUB_ENV
+        fi
+
+    - name: Setup secrets & cache dates
+      if: env.pinned == 'false'
+      run: |
+        echo -ne "url: ${CDSAPI_URL}\nkey: ${CDSAPI_TOKEN}\n" > ~/.cdsapirc
+        echo "week=$(date +'%Y%U')" >> $GITHUB_ENV # data and cutouts
+
+    - uses: actions/cache@v4
+      if: env.pinned == 'false'
+      with:
+        path: |
+          data
+          cutouts
+        key: data-cutouts-${{ env.week }}
+
+    - uses: conda-incubator/setup-miniconda@v3
+      if: env.pinned == 'false'
+      with:
+        activate-environment: pypsa-eur
+
+    - name: Cache Conda env
+      if: env.pinned == 'false'
+      uses: actions/cache@v4
+      with:
+        path: ${{ env.CONDA }}/envs
+        key: conda-pypsa-eur-${{ env.week }}-${{ hashFiles('envs/linux-pinned.yaml') }}
+      id: cache-env
+
+    - name: Update environment
+      if: env.pinned == 'false' && steps.cache-env.outputs.cache-hit != 'true'
+      run: conda env update -n pypsa-eur -f envs/linux-pinned.yaml
+
+    - name: Install package from ref
+      if: env.pinned == 'false'
+      run: |
+        python -m pip install git+https://github.com/${{ github.repository }}@${{ github.event_name == 'pull_request' && github.event.pull_request.head.sha || github.sha }}
+
+    - name: Run snakemake test workflows
+      if: env.pinned == 'false'
+      run: |
+        make test
+
+    - name: Run unit tests
+      if: env.pinned == 'false'
+      run: |
+        make unit-test
+
+    - name: Upload artifacts
+      if: env.pinned == 'false'
+      uses: actions/upload-artifact@v4
+      with:
+        name: results-pypsa-eur-${{ matrix.version }}
+        path: |
+          logs
+          .snakemake/log
+          results
+        retention-days: 3

.gitignore

@@ -17,6 +17,14 @@ Highs.log
 paper/
 monkeytype.sqlite3
 
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
 
 benchmark/*.pdf
 benchmark/benchmarks

.pre-commit-config.yaml

@@ -9,7 +9,7 @@ repos:
     -   id: trailing-whitespace
     -   id: check-merge-conflict
 -   repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.8.1
+    rev: v0.9.4
     hooks:
     -   id: ruff
         args: [--fix]
@@ -25,7 +25,7 @@ repos:
     hooks:
     -   id: blackdoc
 -   repo: https://github.com/codespell-project/codespell
-    rev: v2.3.0
+    rev: v2.4.1
     hooks:
     -   id: codespell
         types_or: [python, rst, markdown]

doc/release_notes.rst

@@ -1,22 +1,35 @@
 Release Notes
 =============
 
-.. Upcoming Version
-.. ----------------
+Upcoming Version
+----------------
+
+* The internal handling of `Solution` objects was improved for more consistency. Solution objects created from solver calls now preserve the exact index names from the input file.
+* Multiplication of a linear expression by a constant value may now introduce new dimensions.
+* Added method `unstack` to `LinearExpression`, `Variable` and `Constraint` to unstack a dimension.
+
+Version 0.4.4
+--------------
+
+* **IMPORTANT BUGFIX**: The last slice of constraints was not correctly written to LP files in case the constraint size was not a multiple of the slice size. This is fixed now.
+* Solution files that following a different naming scheme of variables and constraints using more than on initial letter in the prefix (e.g. `col123`, `row456`) are now supported.
+* GLPK solver is always called with the `--freemps` option instead of the `--mps` when using the Solver API to solve an external MPS file. `--mps` is for the older fixed-column MPS format that is rarely used nowadays. Almost all fixed MPS files can be parsed by the free MPS format.
 
 * Added extra argument in io methods `explicit_coordinate_names` to allow for export of
   variables and constraints with explicit coordinate names.
 
 Version 0.4.3
 --------------
 
-* When creating slices for variables and constraints (important for the `solve` function), the slicing is now fixed in case now dimension to slice is available.
+* **Version 0.4.3 includes a major bug and can not be installed anymore.**
+* When creating slices for variables and constraints (important for the `solve` function), the slicing is now fixed in case no dimension to slice is available.
 * Added a pandas priority attribute. With this change, the operation with pandas objects is now prioritizing linopy objects over pandas objects. This is useful when the using linopy objects in arithmetic operations with pandas objects, e.g. `a * x` where `a` is a pandas Series/DataFrame and `x` is a linopy variable.
 * The method :meth:`model.to_file <linopy.model.Model.to_file>` now includes a progress argument to enable or disable the progress bar while writing.
 
 Version 0.4.2
 --------------
 
+* **Version 0.4.2 includes a major bug and can not be installed anymore.**
 * Fix the file handler to properly close the file when reading the sense from a problem file.
 
 Version 0.4.1

examples/manipulating-models.ipynb

@@ -64,7 +64,7 @@
     "\n",
     "## Varying lower and upper bounds\n",
     "\n",
-    "Now, let's say we want to set the lower bound of `y(t)` to 1. This would translate to:"
+    "Now, let's say we want to set the lower bound of `x(t)` to 1. This would translate to:"
    ]
   },
   {
@@ -178,7 +178,7 @@
    "metadata": {},
    "source": [
     ".. note::\n",
-    "   The same could have been achieved by calling `m.variables.con1.rhs = 8 * factor`\n",
+    "   The same could have been achieved by calling `m.constraints.con1.rhs = 8 * factor`\n",
     "\n",
     "Let's solve it again!"
    ]

linopy/common.py

@@ -38,6 +38,16 @@
     from linopy.variables import Variable
 
 
+def set_int_index(series: pd.Series) -> pd.Series:
+    """
+    Convert string index to int index.
+    """
+    if not series.empty and not pd.api.types.is_integer_dtype(series.index):
+        cutoff = count_initial_letters(str(series.index[0]))
+        series.index = series.index.str[cutoff:].astype(int)
+    return series
+
+
 def maybe_replace_sign(sign: str) -> str:
     """
     Replace the sign with an alternative sign if available.
@@ -519,7 +529,7 @@ def iterate_slices(
         return
 
     # number of slices
-    n_slices = max(size // slice_size, 1)
+    n_slices = max((size + slice_size - 1) // slice_size, 1)
 
     # leading dimension (the dimension with the largest size)
     sizes = {dim: ds.sizes[dim] for dim in slice_dims}
@@ -533,12 +543,12 @@ def iterate_slices(
     if size_of_leading_dim < n_slices:
         n_slices = size_of_leading_dim
 
-    chunk_size = ds.sizes[leading_dim] // n_slices
+    chunk_size = (ds.sizes[leading_dim] + n_slices - 1) // n_slices
 
     # Iterate over the Cartesian product of slice indices
     for i in range(n_slices):
         start = i * chunk_size
-        end = start + chunk_size
+        end = min(start + chunk_size, size_of_leading_dim)
         slice_dict = {leading_dim: slice(start, end)}
         yield ds.isel(slice_dict)
 
@@ -547,6 +557,19 @@ def _remap(array, mapping):
     return mapping[array.ravel()].reshape(array.shape)
 
 
+def count_initial_letters(word: str):
+    """
+    Count the number of initial letters in a word.
+    """
+    count = 0
+    for char in word:
+        if char.isalpha():
+            count += 1
+        else:
+            break
+    return count
+
+
 def replace_by_map(ds, mapping):
     """
     Replace values in a DataArray by a one-dimensional mapping.