Confusion about the `CommodityType` parameter
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
Research direction
Start with the linked CommodityType documentation, then compare the heat and cook examples in the example models/tutorials. Read the is_enduse function and its handling of Energy, Environmental, and Service. Done means the documentation and examples clearly agree on the valid end-use value and explain why.
Written by the indexing model from the issue text.
Description
The documentation for this parameter states that "Service" should be used for end-use commodities such as heating, however the example models/tutorials use "Energy" for the heat and cook commodities. This is confusing and needs to be clarified.
Looking at the code, "Energy" and "Environmental" are the only CommodityType options that are directly referenced. For end-use commodities, the important thing is that they get picked up by the is_enduse function, but this will be true for any products that are not the "Environmental" type (so it doesn't actually matter if it's "Service" or "Energy")
- Dominant language
- Python
- Stars
- 29
- Forks
- 12
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- No contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from EnergySystemsModellingLab/MUSE_OS
-
Release notes for v2.2.0May be free again @tsmbland claimed this 44 days ago, and no pull request is open. Open
EnergySystemsModellingLab/MUSE_OS#850 · 1 assignee ·
-
bug
Difficulty 3/5 1-2 days Newbie friendliness 35/100
-
[BUG] MUSE stopping without error/warning messageMay be free again @sharwaridixit claimed this 320 days ago, and no pull request is open. Openbug
EnergySystemsModellingLab/MUSE_OS#804 · 2 comments · 3 assignees ·
-
[BUG] Global commodities column name mapping conflictMay be free again @tsmbland claimed this 365 days ago, and no pull request is open. Openbug
EnergySystemsModellingLab/MUSE_OS#795 · 5 comments · 2 assignees ·
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
All issues in EnergySystemsModellingLab/MUSE_OS
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 91/100
TencentCloud/Octop#1577 · 1 comment ·
Maintainers usually reply within 1 day
-
bug frontend
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
PedestrianDynamics/pyFDS-Evac#552 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
resend/resend-skills#144 ·
Maintainers usually reply within 1 day
-
good first issue
Difficulty 1/5 Under an hour Newbie friendliness 68/100