forked from NREL/GEOPHIRES-X
-
Notifications
You must be signed in to change notification settings - Fork 1
Parameters Reference Output update (GEOPHIRES result schema) #62
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
Conversation
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
…on for Project NPV
…name is a display name
…d) generated result schema
Closed
1 task
…better with OpenAPI schema standard)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description:
User feedback has consistently indicated a need for greater transparency/visibility into what GEOPHIRES outputs are and how they are calculated. This change updates the existing Parameters Reference Outputs section to correctly display the list of existing outputs and includes internal refactoring to enable additional future enhancements to address these user requests.
geophires-result.json
schema equivalent to existing schema for request (geophires-request.json
)geophires-result.json
schema instead ofOutputParameterDict
s, with the following benefits:OutputParameterDict
s only loosely correlates with the fields output in the case report due to the extensive amount of transformation/display logic in Outputs.py (broadly conceptually relevant to the motivation behind Rich output code cordoning, HTML image fix NREL/GEOPHIRES-X#374), rendering it arguably useless and even actively misleading to users.display_name
property toOutputParameter
to link instances where an output parameter was being rendered in Outputs.py with a field name different from itsName
Generally or partially relevant to:
Testing & Verification
Added unit tests for result schema generation, output parameter JSON types, and outputs RST
Manually verified updated RST is correct (note this is the RST preview in PyCharm, which looks visually different from the HTML version deployed to GitHub pages):

Note that these changes do not affect any GEOPHIRES calculations, thus no example cases or other core functionality unit tests required updating
Follow-ups/TODOs:
categories
property: 4547c3bhip-ra-x-result.json
/outputs reference update TODO