Refactor cost models
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 71
- Forks
- 27
- Avg merge
- 2d 18h
- Merged PRs (30d)
- 33
Description
The cost models need documenting, as mentioned in #2932, however, the cost models are currently pythonised fortran code that hasn't been updated in a while. As such, documenting the cost models would be a difficult task with them in their current form. The function names and docstrings need rewriting to properly clarify what the functions do and what the variables in them are. Recent refactoring of other models in PROCESS should be used as a template for consistency across the code.
This should be done either as part of documenting the cost models or before, to simplify the documentation process.
Contributor 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.
Research direction
Start by inspecting the current cost-model code and recent refactoring of other PROCESS models, which the issue identifies as the consistency template. Review the function names, docstrings, and variables across the cost models. Done means the model APIs and explanations are clear enough to support later documentation and follow the established refactoring style.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend, documentation
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100