flixopt 2.2.0b0__tar.gz → 2.2.0rc2__tar.gz

flixopt-2.2.0rc2/.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.2.0rc2/.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.2.0rc2/.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.2.0rc2/.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.2.0rc2/.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.2.0rc2/.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
+- [x] My code follows the project style
+- [x] I have updated documentation if needed
+- [x] I have added tests for new functionality (if applicable)