Skip to content
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

docs: update advanced model #522

Merged
merged 4 commits into from
Jun 14, 2024
Merged

docs: update advanced model #522

merged 4 commits into from
Jun 14, 2024

Conversation

frodehk
Copy link
Contributor

@frodehk frodehk commented Jun 11, 2024

ECALC-531

Have you remembered and considered?

  • I have remembered to update documentation
  • I have used conventional commits syntax (if you squash, make sure that conventional commit is used)
  • I have included the Jira issue ID somewhere in the commit body (ECALC-XXXX)

Why is this pull request needed?

Update examples in eCalc docs to be representative and avoid invalid timesteps. This can be confusing for externals.

What does this pull request change?

  • Update Advanced model example with new updated yaml file. Changes in modelling to avoid invalid timesteps. This is aligned with what is being used in courses
  • Keep old examples under Course material, for use in training. E.g. to show how to fix invalid timesteps.

Issues related to this change:

https://equinor-ecalc.atlassian.net/browse/ECALC-531?atlOrigin=eyJpIjoiODc3MmU1MmEyNWIzNGVkYTg1YTRmZDBlYjc0OTg4MWYiLCJwIjoiaiJ9

@frodehk frodehk requested a review from a team as a code owner June 11, 2024 09:21
@frodehk frodehk self-assigned this Jun 11, 2024
Copy link
Contributor

@jsolaas jsolaas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice!

I'm assuming the yaml has changed here also? It would be easier to see the changes if moving into files and changes was separated. The renaming of advanced from md to mdx is also not captured, so it looks like a delete and create instead. Not sure how important that is, someone else should probably verify the actual content :)

@frodehk frodehk requested a review from a team as a code owner June 13, 2024 09:21
@frodehk
Copy link
Contributor Author

frodehk commented Jun 13, 2024

Very nice!

I'm assuming the yaml has changed here also? It would be easier to see the changes if moving into files and changes was separated. The renaming of advanced from md to mdx is also not captured, so it looks like a delete and create instead. Not sure how important that is, someone else should probably verify the actual content :)

I agree, it was all in one go. The yaml-content has changed as well, more advanced model. The original yaml (advanced) is now under course content. The simple model in examples and course content is identical for now. The simple model is updated (input file update only) in a separate PR.

@frodehk frodehk changed the title docs: update advanced- and simple model docs: update advanced model Jun 13, 2024
@frodehk frodehk merged commit e8d4b34 into main Jun 14, 2024
9 checks passed
@frodehk frodehk deleted the ECALC-531-update-advanced-model branch June 14, 2024 07:39
equinor-schen pushed a commit that referenced this pull request Aug 23, 2024
* docs: update advanced model

ECALC-531
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants