flixopt 2.1.2__tar.gz → 2.1.3__tar.gz

flixopt-2.1.3/.github/CONTRIBUTING.md

@@ -0,0 +1,85 @@
+# Contributing to FlixOpt
+
+Thanks for your interest in contributing to FlixOpt! 🚀
+
+## Quick Start
+
+1. **Fork & Clone**
+   ```bash
+   git clone https://github.com/yourusername/flixopt.git
+   cd flixopt
+   ```
+
+2. **Install for Development**
+   ```bash
+   pip install -e ".[full]"
+   ```
+
+3. **Make Changes & Submit PR**
+   ```bash
+   git checkout -b feature/your-change
+   # Make your changes
+   git commit -m "Add: description of changes"
+   git push origin feature/your-change
+   # Create Pull Request on GitHub
+   ```
+
+## How to Contribute
+
+### 🐛 **Found a Bug?**
+Use our [bug report template](https://github.com/flixOpt/flixopt/issues/new?template=bug_report.yml) with:
+- Minimal code example
+- FlixOpt version, Python version, solver used
+- Expected vs actual behavior
+
+### ✨ **Have a Feature Idea?**
+Use our [feature request template](https://github.com/flixOpt/flixopt/issues/new?template=feature_request.yml) with:
+- Clear energy system use case
+- Specific examples of what you want to model
+
+### ❓ **Need Help?**
+- Check the [documentation](https://flixopt.github.io/flixopt/latest/) first
+- Search [existing issues](https://github.com/flixOpt/flixopt/issues)
+- Start a [discussion](https://github.com/flixOpt/flixopt/discussions)
+
+## Code Guidelines
+
+- **Style**: Follow PEP 8, use descriptive names
+- **Documentation**: Add docstrings with units (kW, kWh, etc.) if applicable
+- **Energy Focus**: Use energy domain terminology consistently
+- **Testing**: Test with different solvers when applicable
+
+### Example
+```python
+def create_storage(
+    label: str,
+    capacity_kwh: float,
+    charging_power_kw: float
+) -> Storage:
+    """
+    Create a battery storage component.
+    
+    Args:
+        label: Unique identifier
+        capacity_kwh: Storage capacity [kWh]
+        charging_power_kw: Maximum charging power [kW]
+    """
+```
+
+## What We Welcome
+
+- 🔧 New energy components (batteries, heat pumps, etc.)
+- 📚 Documentation improvements
+- 🐛 Bug fixes
+- 🧪 Test cases
+- 💡 Energy system examples
+
+## Questions?
+
+- 📖 [Documentation](https://flixopt.github.io/flixopt/latest/)
+- 💬 [Discussions](https://github.com/flixOpt/flixopt/discussions)
+- 📧 Contact maintainers (see README)
+
+---
+
+**Every contribution helps advance sustainable energy solutions! 🌱⚡**

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

@@ -0,0 +1,81 @@
+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!
+- type: checkboxes
+  id: checks
+  attributes:
+    label: Version Checks (indicate both or one)
+    options:
+    - label: >
+        I have confirmed this bug exists on the latest
+        [release](https://github.com/flixOpt/flixopt/releases) of FlixOpt.
+    - label: >
+        I have confirmed this bug exists on the current
+        [`main`](https://github.com/flixOpt/flixopt/tree/main) branch of FlixOpt.
+- 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 reproducible example. See how to [craft minimal bug reports](https://matthewrocklin.com/minimal-bug-reports).
+    placeholder: >
+      import flixopt as fx
+      
+      # Create simple energy system that reproduces the bug
+      timesteps = pd.date_range('2024-01-01', periods=24, freq='h')
+      flow_system = fx.FlowSystem(timesteps)
+      
+      # Add your components here...
+    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: dropdown
+  id: solver
+  attributes:
+    label: Solver Used
+    description: Which solver were you using when the bug occurred?
+    options:
+      - HiGHS (default)
+      - Gurobi
+      - CPLEX
+      - GLPK
+      - Other (please specify in description)
+  validations:
+    required: true
+- 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 with your environment info
+      ```
+      
+      </details>

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

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: ❓ Questions & Discussion
+    url: https://github.com/flixOpt/flixopt/discussions
+    about: Ask questions and discuss with the community
+  - name: 📖 Documentation
+    url: https://flixopt.github.io/flixopt/latest/
+    about: Check our documentation for guides and examples

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

@@ -0,0 +1,88 @@
+name: Feature Request
+description: Suggest a new feature or enhancement for FlixOpt.
+title: "[FEATURE] "
+labels: ["type: feature"]
+body:
+- type: markdown
+  attributes:
+    value: |
+      Thanks for suggesting a new feature! Please provide as much detail as possible.
+- type: checkboxes
+  id: checks
+  attributes:
+    label: Prerequisite Checks
+    options:
+    - label: >
+        I have searched the [existing issues](https://github.com/flixOpt/flixopt/issues)
+        and confirmed this feature doesn't already exist.
+    - label: >
+        I have checked the [documentation](https://flixopt.github.io/flixopt/latest/)
+        to ensure this feature isn't already available.
+- type: textarea
+  id: problem
+  attributes:
+    label: Is your feature request related to a problem?
+    description: >
+      A clear and concise description of what the problem is.
+    placeholder: >
+      I'm always frustrated when modeling [specific energy system scenario]...
+- type: textarea
+  id: solution
+  validations:
+    required: true
+  attributes:
+    label: Describe the solution you'd like
+    description: >
+      A clear and concise description of what you want to happen.
+    placeholder: >
+      I would like to be able to model [specific component/feature]...
+- type: textarea
+  id: use-case
+  validations:
+    required: true
+  attributes:
+    label: Energy System Use Case
+    description: >
+      Describe your specific energy system modeling scenario and how this feature would help.
+    placeholder: >
+      I'm modeling a district heating system with seasonal thermal storage and need to...
+- type: textarea
+  id: example
+  attributes:
+    label: Desired Code Example (optional)
+    description: >
+      If possible, show how you would like to use this feature in code.
+    placeholder: >
+      # Example of how the new feature might work
+      thermal_storage = fx.SeasonalStorage(
+          label='seasonal_storage',
+          capacity_mwh=1000,
+          efficiency=0.95
+      )
+    render: python
+- type: dropdown
+  id: component-type
+  attributes:
+    label: Component Category (if applicable)
+    description: What type of energy system component does this relate to?
+    options:
+      - Storage (batteries, thermal storage, etc.)
+      - Generation (PV, wind, CHP, etc.)
+      - Conversion (heat pumps, boilers, etc.)
+      - Network/Grid (transmission, distribution)
+      - Optimization/Calculation (algorithms, solvers)
+      - Data/Input handling
+      - Results/Output
+      - Other
+- type: textarea
+  id: alternatives
+  attributes:
+    label: Alternatives considered
+    description: >
+      Describe any alternative solutions or workarounds you've considered.
+- type: textarea
+  id: additional-context
+  attributes:
+    label: Additional context
+    description: >
+      Add any other context, research papers, or examples about the feature request here.

flixopt-2.1.3/.github/pull_request_template.md

@@ -0,0 +1,20 @@
+## Description
+Brief description of the changes in this PR.
+
+## Type of Change
+- [ ] Bug fix
+- [ ] New feature
+- [ ] Documentation update
+- [ ] Code refactoring
+
+## Related Issues
+Closes #(issue number)
+
+## Testing
+- [ ] I have tested my changes
+- [ ] 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)

{flixopt-2.1.2 → flixopt-2.1.3}/.github/workflows/python-app.yaml

@@ -181,4 +181,38 @@ jobs:
           # Install from PyPI
           pip install $PACKAGE_NAME
           # Basic import test
-          python -c "import flixopt; print('PyPI installation successful!')"
+          python -c "import flixopt; print('PyPI installation successful!')"
+
+  deploy-docs:
+    name: Deploy Documentation
+    runs-on: ubuntu-22.04
+    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@v4
+        with:
+          fetch-depth: 0  # Fetch all history for proper versioning
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+
+      - 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.2 → flixopt-2.1.3}/CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.1.3] - 2025-07-08
+
+### Fixed
+- Using `Effect.maximum_operation_per_hour` raised an error, needing an extra timestep. This has been fixed.
+
 ## [2.1.2] - 2025-06-14
 
 ### Fixed

{flixopt-2.1.2 → flixopt-2.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flixopt
-Version: 2.1.2
+Version: 2.1.3
 Summary: Vector based energy and material flow optimization framework in Python.
 Author-email: "Chair of Building Energy Systems and Heat Supply, TU Dresden" <peter.stange@tu-dresden.de>, Felix Bumann <felixbumann387@gmail.com>, Felix Panitz <baumbude@googlemail.com>, Peter Stange <peter.stange@tu-dresden.de>
 Maintainer-email: Felix Bumann <felixbumann387@gmail.com>, Peter Stange <peter.stange@tu-dresden.de>

{flixopt-2.1.2 → flixopt-2.1.3}/flixopt/core.py

@@ -62,13 +62,17 @@ class DataConverter:
                 return xr.DataArray(data, coords=coords, dims=dims)
             elif isinstance(data, pd.DataFrame):
                 if not data.index.equals(timesteps):
-                    raise ConversionError("DataFrame index doesn't match timesteps index")
+                    raise ConversionError(f"DataFrame index doesn't match timesteps index. "
+                                          f"Its missing the following time steps: {timesteps.difference(data.index)}. "
+                                          f"Some parameters might need an extra timestep at the end.")
                 if not len(data.columns) == 1:
                     raise ConversionError('DataFrame must have exactly one column')
                 return xr.DataArray(data.values.flatten(), coords=coords, dims=dims)
             elif isinstance(data, pd.Series):
                 if not data.index.equals(timesteps):
-                    raise ConversionError("Series index doesn't match timesteps index")
+                    raise ConversionError(f"Series index doesn't match timesteps index. "
+                                          f"Its missing the following time steps: {timesteps.difference(data.index)}. "
+                                          f"Some parameters might need an extra timestep at the end.")
                 return xr.DataArray(data.values, coords=coords, dims=dims)
             elif isinstance(data, np.ndarray):
                 if data.ndim != 1:

{flixopt-2.1.2 → flixopt-2.1.3}/flixopt/effects.py

@@ -94,7 +94,7 @@ class Effect(Element):
             f'{self.label_full}|minimum_operation_per_hour', self.minimum_operation_per_hour
         )
         self.maximum_operation_per_hour = flow_system.create_time_series(
-            f'{self.label_full}|maximum_operation_per_hour', self.maximum_operation_per_hour, flow_system
+            f'{self.label_full}|maximum_operation_per_hour', self.maximum_operation_per_hour,
         )
 
         self.specific_share_to_other_effects_operation = flow_system.create_effect_time_series(

{flixopt-2.1.2 → flixopt-2.1.3}/flixopt.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flixopt
-Version: 2.1.2
+Version: 2.1.3
 Summary: Vector based energy and material flow optimization framework in Python.
 Author-email: "Chair of Building Energy Systems and Heat Supply, TU Dresden" <peter.stange@tu-dresden.de>, Felix Bumann <felixbumann387@gmail.com>, Felix Panitz <baumbude@googlemail.com>, Peter Stange <peter.stange@tu-dresden.de>
 Maintainer-email: Felix Bumann <felixbumann387@gmail.com>, Peter Stange <peter.stange@tu-dresden.de>

{flixopt-2.1.2 → flixopt-2.1.3}/flixopt.egg-info/SOURCES.txt

@@ -4,7 +4,11 @@ LICENSE
 README.md
 mkdocs.yml
 pyproject.toml
-.github/workflows/deploy-docs.yaml
+.github/CONTRIBUTING.md
+.github/pull_request_template.md
+.github/ISSUE_TEMPLATE/bug_report.yml
+.github/ISSUE_TEMPLATE/config.yml
+.github/ISSUE_TEMPLATE/feature_request.yml
 .github/workflows/python-app.yaml
 docs/SUMMARY.md
 docs/contribute.md

flixopt-2.1.2/.github/workflows/deploy-docs.yaml

@@ -1,37 +0,0 @@
-name: Documentation
-
-on:
-  release:
-    types: [created]  # Automatically deploy docs on release
-  workflow_dispatch:  # Allow manual triggering
-
-jobs:
-  deploy-docs:
-    runs-on: ubuntu-latest
-    # Only deploy docs for stable releases (not pre-releases)
-    if: github.event.release.prerelease == false
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0  # Fetch all history for proper versioning
-
-      - name: Configure Git Credentials
-        run: |
-          git config user.name github-actions[bot]
-          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
-
-      - uses: actions/setup-python@v5
-        with:
-          python-version: 3.11
-
-      - name: Install documentation dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install -e ".[docs]"
-
-      - name: Deploy docs
-        run: |
-          VERSION=${GITHUB_REF#refs/tags/v}
-          echo "Deploying docs for stable release: $VERSION"
-          mike deploy --push --update-aliases $VERSION latest
-          mike set-default --push latest