flixopt 2.1.6__tar.gz → 2.1.7__tar.gz

{flixopt-2.1.6 → flixopt-2.1.7}/.github/CONTRIBUTING.md

@@ -58,7 +58,7 @@ def create_storage(
 ) -> Storage:
     """
     Create a battery storage component.
-    
+
     Args:
         label: Unique identifier
         capacity_kwh: Storage capacity [kWh]
@@ -82,4 +82,4 @@ def create_storage(
 
 ---
 
-**Every contribution helps advance sustainable energy solutions! 🌱⚡**
+**Every contribution helps advance sustainable energy solutions! 🌱⚡**

flixopt-2.1.7/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,111 @@
+name: 🐛 Bug Report
+description: Report a bug in flixopt
+title: "[BUG] "
+labels: ["type: bug"]
+body:
+- type: markdown
+  attributes:
+    value: |
+      Thanks for taking the time to fill out this bug report!
+
+      **Before submitting**: Please search [existing issues](https://github.com/flixOpt/flixopt/issues) to avoid duplicates.
+
+- type: checkboxes
+  id: checks
+  attributes:
+    label: Version Confirmation
+    description: Please confirm you can reproduce this on a supported version
+    options:
+    - label: I have confirmed this bug exists on the latest [release](https://github.com/flixOpt/flixopt/releases) of FlixOpt
+      required: true
+
+- type: textarea
+  id: problem
+  attributes:
+    label: Bug Description
+    description: Clearly describe what went wrong
+    placeholder: |
+      What happened? What did you expect to happen instead?
+
+      Include any error messages or unexpected outputs.
+  validations:
+    required: true
+
+- type: textarea
+  id: example
+  attributes:
+    label: Minimal Reproducible Example
+    description: |
+      Provide the smallest possible code example that reproduces the bug.
+      See [how to create minimal bug reports](https://matthewrocklin.com/minimal-bug-reports).
+    placeholder: |
+      import flixopt as fx
+      import pandas as pd
+
+      # Minimal example that reproduces the bug
+      timesteps = pd.date_range('2024-01-01', periods=24, freq='h')
+      flow_system = fx.FlowSystem(timesteps)
+
+      # Add components that trigger the bug...
+
+      # Show the problematic operation
+      result = flow_system.solve()  # This should fail/behave unexpectedly
+    render: python
+  validations:
+    required: true
+
+- type: textarea
+  id: error-output
+  attributes:
+    label: Error Output
+    description: If there's an error message, paste the full traceback here
+    render: shell
+
+- type: dropdown
+  id: solver
+  attributes:
+    label: Solver Used
+    description: Which solver were you using?
+    options:
+      - HiGHS (default)
+      - Gurobi
+      - CPLEX
+      - GLPK
+      - CBC
+      - Other (specify below)
+  validations:
+    required: true
+
+- type: input
+  id: os
+  attributes:
+    label: Operating System
+    placeholder: "e.g., Windows 11, macOS 14.2, Ubuntu 22.04"
+  validations:
+    required: true
+
+- type: input
+  id: python-version
+  attributes:
+    label: Python Version
+    placeholder: "e.g., 3.11.5"
+  validations:
+    required: true
+
+- type: textarea
+  id: environment
+  attributes:
+    label: Environment Info
+    description: |
+      Run one of these commands and paste the output:
+      - `pip freeze`
+      - `conda env export`
+    render: shell
+    value: >
+      <details>
+
+      ```
+      Replace this with your environment info
+      ```
+
+      </details>

flixopt-2.1.7/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,14 @@
+blank_issues_enabled: false
+contact_links:
+  - name: 🤔 Modeling Questions
+    url: https://github.com/flixOpt/flixopt/discussions/categories/q-a
+    about: "How to model specific energy systems, components, and constraints"
+  - name: ⚡ Performance & Optimization
+    url: https://github.com/flixOpt/flixopt/discussions/categories/performance
+    about: "Solver performance, memory usage, and optimization speed issues"
+  - name: 💡 Ideas & Suggestions
+    url: https://github.com/flixOpt/flixopt/discussions/categories/ideas
+    about: "Share ideas and discuss potential improvements with the community"
+  - name: 📖 Documentation
+    url: https://flixopt.github.io/flixopt/latest/
+    about: "Browse guides, API reference, and examples"

flixopt-2.1.7/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,127 @@
+name: ✨ Feature Request
+description: Suggest a new feature or enhancement
+title: "[FEATURE] "
+labels: ["type: feature"]
+body:
+- type: markdown
+  attributes:
+    value: |
+      Thanks for suggesting a new feature!
+
+      **Before submitting**: Please search [existing issues](https://github.com/flixOpt/flixopt/issues) and check our [roadmap](https://github.com/flixOpt/flixopt/discussions) to avoid duplicates.
+
+- type: checkboxes
+  id: checks
+  attributes:
+    label: Prerequisites
+    options:
+    - label: I have searched existing issues and discussions
+      required: true
+    - label: I have checked the [documentation](https://flixopt.github.io/flixopt/latest/)
+      required: true
+
+- type: dropdown
+  id: feature-type
+  attributes:
+    label: Feature Category
+    description: What type of feature is this?
+    options:
+      - New Component (storage, generation, conversion, etc.)
+      - Enhancement to Existing Component
+      - New Optimization Feature
+      - Data Input/Output Improvement
+      - Results/Visualization Enhancement
+      - Performance/Solver Improvement
+      - API/Usability Improvement
+      - Documentation/Examples
+      - Other
+  validations:
+    required: true
+
+- type: textarea
+  id: problem
+  attributes:
+    label: Problem Statement
+    description: What problem would this feature solve?
+    placeholder: |
+      Current limitation: "FlixOpt doesn't support [specific energy system component/feature]..."
+
+      Impact: "This prevents users from modeling [specific scenarios]..."
+
+- type: textarea
+  id: solution
+  attributes:
+    label: Proposed Solution
+    description: Describe your proposed solution in detail
+    placeholder: |
+      I propose adding a new component/feature that would...
+
+      Key capabilities:
+      - Feature 1
+      - Feature 2
+      - Feature 3
+  validations:
+    required: true
+
+- type: textarea
+  id: use-case
+  attributes:
+    label: Use Case & Examples
+    description: Provide concrete examples of how this would be used
+    placeholder: |
+      Real-world scenario: "I'm modeling a microgrid with battery storage and need to..."
+
+      Specific requirements:
+      - Must handle [specific constraint]
+      - Should support [specific behavior]
+      - Would benefit [specific user group]
+  validations:
+    required: true
+
+- type: textarea
+  id: code-example
+  attributes:
+    label: Desired API (Optional)
+    description: Show how you'd like to use this feature
+    placeholder: |
+      # Example of proposed API
+      component = fx.NewComponent(
+          label='example',
+          parameter1=value1,
+          parameter2=value2
+      )
+
+      flow_system.add_component(component)
+    render: python
+
+- type: textarea
+  id: alternatives
+  attributes:
+    label: Alternatives Considered
+    description: What workarounds or alternatives have you tried?
+    placeholder: |
+      Current workaround: "I'm currently using [existing component] but it doesn't support..."
+
+      Other approaches considered: "I looked into [alternative] but..."
+
+- type: dropdown
+  id: priority
+  attributes:
+    label: Priority/Impact
+    description: How important is this feature for your work?
+    options:
+      - Critical - Blocking important work
+      - High - Would significantly improve workflow
+      - Medium - Nice to have enhancement
+      - Low - Minor improvement
+
+- type: textarea
+  id: additional-context
+  attributes:
+    label: Additional Context
+    description: References, papers, examples from other tools, etc.
+    placeholder: |
+      References:
+      - Research paper: [Title and link]
+      - Similar feature in [other tool]: [description]
+      - Industry standard: [description]

flixopt-2.1.7/.github/ISSUE_TEMPLATE/general_issue.yml

@@ -0,0 +1,40 @@
+name: 📝 General Issue
+description: For issues that don't fit the specific templates below
+title: ""
+body:
+  - type: markdown
+    attributes:
+      value: |
+        **For specific issue types, please use the dedicated templates:**
+        - 🐛 **Bug Report** - Something is broken or not working as expected
+        - ✨ **Feature Request** - Suggest new functionality
+
+        **For other topics, consider using Discussions instead:**
+        - 🤔 [Modeling Questions](https://github.com/flixOpt/flixopt/discussions/categories/q-a) - How to model specific energy systems
+        - ⚡ [Performance Help](https://github.com/flixOpt/flixopt/discussions/categories/performance) - Optimization speed and memory issues
+
+  - type: textarea
+    id: issue-description
+    attributes:
+      label: Issue Description
+      description: Describe your issue, question, or concern
+      placeholder: |
+        Please describe:
+        - What you're trying to accomplish
+        - What's not working as expected
+        - Any relevant context or background
+    validations:
+      required: true
+
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional Context
+      description: Code examples, environment details, error messages, etc.
+      placeholder: |
+        Optional: Add any relevant details like:
+        - Code snippets
+        - Error messages
+        - Environment info
+        - Screenshots
+      render: markdown

{flixopt-2.1.6 → flixopt-2.1.7}/.github/pull_request_template.md

@@ -15,6 +15,6 @@ Closes #(issue number)
 - [ ] Existing tests still pass
 
 ## Checklist
-- [ ] My code follows the project style
-- [ ] I have updated documentation if needed
-- [ ] I have added tests for new functionality (if applicable)
+- [x] My code follows the project style
+- [x] I have updated documentation if needed
+- [x] I have added tests for new functionality (if applicable)

flixopt-2.1.7/.github/workflows/python-app.yaml

@@ -0,0 +1,354 @@
+name: Python Package CI/CD
+
+on:
+  push:
+    branches: [main, dev]  # Added develop branch
+    tags:
+      - 'v*.*.*'  # Trigger on semantic version tags
+  pull_request:
+    branches: [main, dev, 'feature/*', 'hotfix/*', 'fix/*']
+    types: [opened, synchronize, reopened]
+  workflow_dispatch:  # Allow manual triggering
+
+# Set permissions for security
+permissions:
+  contents: read
+
+# Cancel previous runs on new push
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  PYTHON_VERSION: "3.11"
+
+jobs:
+  lint:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v5
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+          cache: 'pip'
+          cache-dependency-path: |
+            pyproject.toml
+
+      - name: Install Ruff
+        run: |
+          python -m pip install --upgrade pip
+          pip install "ruff==0.9.*"
+          ruff --version
+
+      - name: Run Ruff Linting
+        run: |
+          echo "::group::Ruff Linting"
+          ruff check . --output-format=github
+          echo "::endgroup::"
+
+      - name: Run Ruff Formatting Check
+        run: |
+          echo "::group::Ruff Formatting"
+          ruff format --check --diff .
+          echo "::endgroup::"
+
+  test:
+    runs-on: ubuntu-22.04
+    timeout-minutes: 30
+    needs: lint  # Run tests only after linting passes
+    strategy:
+      fail-fast: false  # Continue testing other Python versions if one fails
+      matrix:
+        python-version: ['3.10', '3.11', '3.12', '3.13']
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v5
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: 'pip'
+          cache-dependency-path: |
+            pyproject.toml
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install .[dev] pytest-xdist
+
+      - name: Run tests
+        run: pytest -v -p no:warnings --numprocesses=auto
+
+  security:
+    name: Security Scan
+    runs-on: ubuntu-latest
+    needs: lint
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v5
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+          cache: 'pip'
+          cache-dependency-path: |
+            pyproject.toml
+
+      - name: Install security tools
+        run: |
+          python -m pip install --upgrade pip
+          pip install bandit[toml]
+
+      - name: Run Bandit security scan
+        run: |
+          # Gate on HIGH severity & MEDIUM confidence; produce JSON artifact
+          bandit -r flixopt/ -c pyproject.toml -f json -o bandit-report.json -q -lll -ii
+          # Human-readable output without affecting job status
+          bandit -r flixopt/ -c pyproject.toml -q --exit-zero
+
+      - name: Upload security reports
+        uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: security-report
+          path: bandit-report.json
+          retention-days: 30
+
+  create-release:
+    name: Create GitHub Release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    needs: [lint, test, security]
+    if: startsWith(github.ref, 'refs/tags/v')
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Extract release notes
+        run: |
+          VERSION=${GITHUB_REF#refs/tags/v}
+          echo "Extracting release notes for version: $VERSION"
+          python scripts/extract_release_notes.py $VERSION > current_release_notes.md
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          body_path: current_release_notes.md
+          draft: false
+          prerelease: ${{ contains(github.ref, 'alpha') || contains(github.ref, 'beta') || contains(github.ref, 'rc') }}
+          generate_release_notes: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  publish-testpypi:
+    name: Publish to TestPyPI
+    runs-on: ubuntu-22.04
+    needs: [test, create-release]  # Run after tests and release creation
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')  # Only on tag push
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/flixopt
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v5
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+          cache: 'pip'
+          cache-dependency-path: |
+            pyproject.toml
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build setuptools wheel twine
+
+      - name: Build the distribution
+        run: |
+          python -m build
+
+      - name: Upload to TestPyPI
+        run: |
+          twine upload --repository-url https://test.pypi.org/legacy/ dist/* --verbose
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.TEST_PYPI_API_TOKEN }}
+
+      - name: Test install from TestPyPI
+        run: |
+          # Create a temporary environment to test installation
+          python -m venv test_env
+          source test_env/bin/activate
+          # Get project name from pyproject.toml (PEP 621)
+          PACKAGE_NAME=$(python - <<'PY'
+          import sys, tomllib, pathlib
+          data = tomllib.loads(pathlib.Path("pyproject.toml").read_text(encoding="utf-8"))
+          print(data["project"]["name"])
+          PY
+          )
+          # Extract version from git tag
+          VERSION=${GITHUB_REF#refs/tags/v}
+          # Wait and retry while TestPyPI indexes the package
+          INSTALL_SUCCESS=false
+          for d in 15 30 60 120 180 360 720 1080; do
+            sleep "$d"
+            echo "Attempting to install $PACKAGE_NAME==$VERSION from TestPyPI (retry after ${d}s)..."
+            # Install specific version and verify it matches
+            if pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ "$PACKAGE_NAME==$VERSION" && \
+               python -c "from importlib.metadata import version; installed = version('$PACKAGE_NAME'); print(f'Installed: {installed}'); assert '$VERSION' == installed"; then
+              INSTALL_SUCCESS=true
+              break
+            fi
+          done
+
+          # Check if installation succeeded
+          if [ "$INSTALL_SUCCESS" = "false" ]; then
+            echo "ERROR: Failed to install $PACKAGE_NAME==$VERSION from TestPyPI after all retries"
+            echo "This could indicate:"
+            echo "  - TestPyPI indexing issues"
+            echo "  - Package upload problems"
+            echo "  - Version mismatch between tag and package"
+            exit 1
+          fi
+
+          # Final success confirmation
+          python -c "import flixopt; print('TestPyPI installation successful!')"
+
+  publish-pypi:
+    name: Publish to PyPI
+    runs-on: ubuntu-22.04
+    needs: [publish-testpypi]  # Only run after TestPyPI publish succeeds
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')  # Only on tag push
+    environment:
+      name: pypi
+      url: https://pypi.org/p/flixopt
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v5
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+          cache: 'pip'
+          cache-dependency-path: |
+            pyproject.toml
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build setuptools wheel twine
+
+      - name: Build the distribution
+        run: |
+          python -m build
+
+      - name: Upload to PyPI
+        run: |
+          twine upload dist/* --verbose
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+
+      - name: Verify PyPI installation
+        run: |
+          # Create a temporary environment to test installation
+          python -m venv prod_test_env
+          source prod_test_env/bin/activate
+          # Get project name from pyproject.toml (PEP 621)
+          PACKAGE_NAME=$(python - <<'PY'
+          import sys, tomllib, pathlib
+          data = tomllib.loads(pathlib.Path("pyproject.toml").read_text(encoding="utf-8"))
+          print(data["project"]["name"])
+          PY
+          )
+          # Extract version from git tag
+          VERSION=${GITHUB_REF#refs/tags/v}
+          # Wait and retry while PyPI indexes the package
+          INSTALL_SUCCESS=false
+          for d in 5 10 15 30 60 120 180 360 720 1080; do
+            sleep "$d"
+            echo "Attempting to install $PACKAGE_NAME==$VERSION from PyPI (retry after ${d}s)..."
+            # Install specific version and verify it matches
+            if pip install "$PACKAGE_NAME==$VERSION" && \
+               python -c "from importlib.metadata import version; installed = version('$PACKAGE_NAME'); print(f'Installed: {installed}'); assert '$VERSION' == installed"; then
+              INSTALL_SUCCESS=true
+              break
+            fi
+          done
+
+          # Check if installation succeeded
+          if [ "$INSTALL_SUCCESS" = "false" ]; then
+            echo "ERROR: Failed to install $PACKAGE_NAME==$VERSION from PyPI after all retries"
+            echo "This could indicate:"
+            echo "  - PyPI indexing issues"
+            echo "  - Package upload problems"
+            echo "  - Version mismatch between tag and package"
+            exit 1
+          fi
+
+          # Final success confirmation
+          python -c "import flixopt; print('PyPI installation successful!')"
+
+  deploy-docs:
+    name: Deploy Documentation
+    runs-on: ubuntu-22.04
+    permissions:
+      contents: write
+    needs: [publish-pypi]  # Deploy docs after successful PyPI publishing
+    if: startsWith(github.ref, 'refs/tags/v') && !contains(github.ref, 'alpha') && !contains(github.ref, 'beta') && !contains(github.ref, 'rc')
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v5
+        with:
+          fetch-depth: 0  # Fetch all history for proper versioning
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+          cache: 'pip'
+          cache-dependency-path: |
+            pyproject.toml
+
+      - name: Sync changelog to docs
+        run: |
+          cp CHANGELOG.md docs/changelog.md
+          echo "✅ Synced changelog to docs"
+
+      - name: Install documentation dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[docs]"
+
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+
+      - name: Deploy docs
+        run: |
+          VERSION=${GITHUB_REF#refs/tags/v}
+          echo "Deploying docs after successful PyPI publish: $VERSION"
+          mike deploy --push --update-aliases $VERSION latest
+          mike set-default --push latest

flixopt-2.1.7/.pre-commit-config.yaml

@@ -0,0 +1,16 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+        exclude: ^mkdocs\.yml$  # Skip mkdocs.yml
+      - id: check-added-large-files
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.12.4
+    hooks:
+    - id: ruff-check
+      args: [ --fix ]
+    - id: ruff-format