Documentation on service sector water heating missing
Open
Beginner friendly
Nobody has claimed this yet.
documentation
Sector
- Dominant language
- Python
- Stars
- 148
- Forks
- 55
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 18
Description
Type of documentation issue
Missing Information
Issue Description
No config table options exist for the water_heating config in the service sector.
service_sector:
water_heating:
split_space_water: true
simple_storage: true
n_hours: 4
Link to existing documentation
https://pypsa-usa.readthedocs.io/en/latest/config-sectors.html#service-sector
Suggested Update
No response
Additional Info
No response
Contributor guide
No contributing guide indexed for this repository
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.
Research direction
Start with the service-sector section at the linked documentation page and compare its existing config tables with the shown service_sector.water_heating YAML options. Document split_space_water, simple_storage, and n_hours, including their relevant meanings or settings available from the project. Done means the water-heating configuration is represented in the service-sector documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100