-
Notifications
You must be signed in to change notification settings - Fork 9
Added Zenodo to repository for citations #433
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
5800363
Added Zenodo to repository for citations
FBumann a174301
Update zenodo and README.md
FBumann 812a32d
Update zenodo and CITATION.cff
FBumann b2dc081
Update ORCID
FBumann 1caf765
Improve and synchronize keywords
FBumann b00ec96
Improve and synchronize keywords
FBumann f7af509
Add 'open' status to feature/zenodo
FBumann a052e2a
Use full orcid links
FBumann ba4103e
Update project description
FBumann 1f2bc7d
Update .zenodo.json
PStange 0eb4126
Update .zenodo.json
PStange 863b401
Update .zenodo.json
PStange c0cd7fc
Add citation notice to FlixOpt description
baumbude e3f70eb
Fix JSON description formatting in .zenodo.json
baumbude 1f92efe
Incorporate Backronym into docs and README.md
FBumann b677865
Change backronym translation
FBumann fa9aabe
Change backronym translation
FBumann a8e13ef
Add workflow to update the citation version and date
FBumann c0ede5d
Update README.md
FBumann File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| { | ||
| "title": "FlixOpt: Progressive Flow System Optimization", | ||
| "description": "FlixOpt (Flexible, Low-entry, Investment, X-sector OPTimization) is a comprehensive framework for modeling and optimizing energy and material flow systems in Python. It enables optimization of diverse applications including district heating networks, industrial production lines, renewable energy portfolios, and supply chain logistics. Built on modern scientific Python stack (linopy and xarray), it provides a progressive enhancement approach allowing users to start with simple models and incrementally add complexity such as multi-period investments, stochastic scenarios, and custom constraints. The framework simplifies the creation of global constraints and switching objectives through its 'effect' concept. The framework is designed for researchers and engineers in energy systems, industrial process optimization, and operations research. \\n\\nCitation Notice: If you use FlixOpt in scientific work, please cite both this software version and the following publication: Panitz, F., Behrends, T., & Stange, P. (2022). Software-supported Investment Optimization for District Heating Supply Systems. In EuroSun 2022 Proceedings. DOI: 10.18086/eurosun.2022.04.07", | ||
| "version": "{{VERSION}}", | ||
| "license": "MIT", | ||
| "access_right": "open", | ||
| "upload_type": "software", | ||
| "creators": [ | ||
| { | ||
| "name": "Bumann, Felix", | ||
| "affiliation": "SachsenEnergie AG", | ||
| "orcid": "https://orcid.org/0009-0006-0765-4789" | ||
| }, | ||
| { | ||
| "name": "Panitz, Felix", | ||
| "affiliation": "Fraunhofer Research Institution for Energy Infrastructures and Geotechnologies IEG", | ||
| "orcid": "https://orcid.org/0009-0007-7030-6987" | ||
| }, | ||
| { | ||
| "name": "Stange, Peter", | ||
| "affiliation": "Chair of Building Energy Systems and Heat Supply, TU Dresden", | ||
| "orcid": "https://orcid.org/0009-0001-6407-1495" | ||
| } | ||
| ], | ||
| "contributors": [ | ||
| { | ||
| "name": "Chair of Building Energy Systems and Heat Supply, TU Dresden", | ||
| "type": "HostingInstitution" | ||
| } | ||
| ], | ||
| "keywords": [ | ||
| "optimization", | ||
| "energy systems", | ||
| "energy flow modeling", | ||
| "linear programming", | ||
| "mixed-integer programming", | ||
| "MILP", | ||
| "operations research", | ||
| "python", | ||
| "district heating", | ||
| "renewable energy", | ||
| "multi-period optimization", | ||
| "investment optimization", | ||
| "capacity planning", | ||
| "energy modeling", | ||
| "sector coupling", | ||
| "energy transition", | ||
| "industrial processes", | ||
| "stochastic optimization", | ||
| "linopy", | ||
| "xarray" | ||
| ], | ||
| "language": "eng", | ||
| "grants": [ | ||
| {"id": "03KB159B"} | ||
| ], | ||
| "related_identifiers": [ | ||
| { | ||
| "identifier": "https://github.com/flixOpt/flixopt", | ||
| "relation": "isSupplementTo", | ||
| "scheme": "url" | ||
| }, | ||
| { | ||
| "identifier": "10.18086/eurosun.2022.04.07", | ||
| "relation": "isDocumentedBy", | ||
| "scheme": "doi" | ||
| }, | ||
| { | ||
| "identifier": "https://flixopt.github.io/flixopt/", | ||
| "relation": "isDocumentedBy", | ||
| "scheme": "url" | ||
| }, | ||
| { | ||
| "identifier": "https://pypi.org/project/flixopt/", | ||
| "relation": "isIdenticalTo", | ||
| "scheme": "url" | ||
| } | ||
| ], | ||
| "communities": [ | ||
| { | ||
| "identifier": "energy" | ||
| }, | ||
| { | ||
| "identifier": "zenodo" | ||
| } | ||
| ] | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| cff-version: 1.2.0 | ||
| message: "If you use this software, please cite it as below." | ||
| type: software | ||
| title: "flixopt" | ||
| version: 3.1.1 | ||
| date-released: 2025-10-20 | ||
| url: "https://github.com/flixOpt/flixopt" | ||
| repository-code: "https://github.com/flixOpt/flixopt" | ||
| license: MIT | ||
| abstract: "Progressive flow system optimization in Python. Build simple models quickly, then incrementally add multi-period planning, stochastic scenarios, and custom constraints without refactoring." | ||
| keywords: | ||
| - optimization | ||
| - energy systems | ||
| - energy flow modeling | ||
| - linear programming | ||
| - mixed-integer programming | ||
| - MILP | ||
| - operations research | ||
| - python | ||
| - district heating | ||
| - renewable energy | ||
| - multi-period optimization | ||
| - investment optimization | ||
| - capacity planning | ||
| - energy modeling | ||
| - sector coupling | ||
| - energy transition | ||
| - industrial processes | ||
| - stochastic optimization | ||
| - linopy | ||
| - xarray | ||
| authors: | ||
| - family-names: Bumann | ||
| given-names: Felix | ||
| email: felixbumann387@gmail.com | ||
| affiliation: "SachsenEnergie AG" | ||
| orcid: "https://orcid.org/0009-0006-0765-4789" | ||
| - family-names: Panitz | ||
| given-names: Felix | ||
| email: baumbude@googlemail.com | ||
| affiliation: "Fraunhofer Research Institution for Energy Infrastructures and Geotechnologies IEG" | ||
| orcid: "https://orcid.org/0009-0007-7030-6987" | ||
| - family-names: Stange | ||
| given-names: Peter | ||
| email: peter.stange@tu-dresden.de | ||
| affiliation: "Chair of Building Energy Systems and Heat Supply, TU Dresden" | ||
| orcid: "https://orcid.org/0009-0001-6407-1495" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
❓ Verification inconclusive
Verify Zenodo grants field supports funding source context; add ministry information.
The JSON syntax is correct and
access_rightfield is now properly included—past issues are resolved. However, the PR objectives (comment from PStange) specifically request inclusion of funding information: "This project was founded by the German Federal Ministry for Economic Affairs and Energy (FKZ: 03KB159B)."The grants field (lines 54–56) currently contains only the FKZ ID. The funding source (ministry name) is absent from all metadata fields, which does not satisfy the stated requirement.
To determine the best way to include the ministry information, I need to verify Zenodo's grants field structure. The standard Zenodo grants field typically accepts only an
"id"subfield, but some versions may support additional metadata. Please check the Zenodo API documentation or metadata schema for your target Zenodo instance to confirm:"title","funder", or similar) beyond"id".Once confirmed, apply this fix (or similar) to include the ministry name. For example, if grants supports a funder field:
Alternatively, if the description is the correct place, ensure it includes the funding source attribution.
Add German Federal Ministry attribution to description field.
The previous JSON syntax and
access_rightissues are resolved. However, the grants field accepts only OpenAIRE-formatted IDs—it cannot store additional funder context. Zenodo's .zenodo.json grants field supports only the "id" subfield.The PR objective requests: "This project was founded by the German Federal Ministry for Economic Affairs and Energy (FKZ: 03KB159B)." This information is currently absent from the metadata. Following practice in other German-funded research deposits, the funding attribution should be added to the description field.
Update line 3 (description) to include the ministry name and grant code, for example:
🤖 Prompt for AI Agents