IDAES/idaes-pse

Add documentation for reporting units

Open

#1,539 opened on Nov 15, 2024

View on GitHub
 (2 comments) (0 reactions) (1 assignee)Python (314 forks)auto 404
Priority:Lowdocumentationgood first issue

Repository metrics

Stars
 (330 stars)
PR merge metrics
 (PR metrics pending)

Description

I recently received a question from a user about changing what set of units certain variables are reported in. I am dimly aware that there exists functionality in IDAES to set reporting units, but I am not aware of the specifics. I looked for documentation, but it appears there isn't any. I know there's a function in idaes\core\util\units_of_measurements.py associated with the functionality, as well as a line in the config, but I don't know how either of those work and don't have the time to do a full investigation.

This gap in our documentation needs to be filled by somebody.

Contributor guide

Research direction
Investigate the existing function in idaes/core/util/units of measurement.py and the config line in idaes/config.py to understand how reporting units work, then create documentation explaining the functionality and usage.
Tech stack
python
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75