Ecalc 619 improve and restructure keyword docs #340
Closed
Conversation
This file contains 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
* docs: maximum pressure ratio per stage in docs
ecalc.py is actually energy calculator
EnergyCalculator represents an application specific usage of the eCalc domain.
graph result represents an application specific result.
downgraded pydantic to v1 because we still need to set that as dependency until we have changed everything to v2
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Removed yellow lines from all_energy_usage_models
* docs: update migration guide and description venting emitters
|
Rebase issue - new pr. |
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.
Why is this pull request needed?
The documentation of different eCalc keywords can be difficult to navigate, especially for unexperienced users. There are also keywords without context in the documentation, e.g. RATE. The search functionality is helpful, but in many cases maybe not enough (you need to know what to look for).
A more logical structure of the keyword documentation may improve the understanding and user experience. Both for beginners and more experienced users.
A more structured apporach could be to have 5 top level keywords in sidebar, reflecting the main yaml-sections. Then the user can navigate to the desired section, recognizable from the yaml-model setup. The modelling guide can be referenced for details.
What does this pull request change?
Create a new test structure of the Yaml keywords, investigate usability:
Issues related to this change:
https://equinor-ecalc.atlassian.net/browse/ECALC-619?atlOrigin=eyJpIjoiZWE2ZmU4NTNiYTZmNDZkNTgxNjRjZTRmYWMzOWJiODMiLCJwIjoiaiJ9