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

fix: Output width limit #167

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

fix: Output width limit #167

wants to merge 10 commits into from

Conversation

Aleksander-Karlsson
Copy link
Collaborator

@Aleksander-Karlsson Aleksander-Karlsson commented Sep 27, 2024

Description

Include a description of the change done

  • Ensure output data (not comments) are below character width limit of 132.
  • Line break default multi-word header names.
  • Enable check on ~100 tests checking for width of output.

Why

The motivation for the change (if applicable)
Some reservoir simulators using our output have character limits.

Close: #166

Checklist:

Before submitting this PR, please make sure:

  • I am complying with the contributing doc
  • My code builds clean without any errors or warnings
  • I have added/extended tests that prove my fix is effective or that my feature works
  • I have made corresponding changes to the documentation, and it builds correctly

@Aleksander-Karlsson Aleksander-Karlsson self-assigned this Sep 27, 2024
@Aleksander-Karlsson Aleksander-Karlsson marked this pull request as ready for review October 2, 2024 09:19
@Aleksander-Karlsson Aleksander-Karlsson requested a review from a team as a code owner October 2, 2024 09:19
@MegaAnda123 MegaAnda123 self-requested a review October 2, 2024 10:20
Copy link
Collaborator

@MegaAnda123 MegaAnda123 left a comment

Choose a reason for hiding this comment

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

Some comments.

Headers.SCALE_FACTOR: "{:.10g}".format,
Headers.ROUGHNESS: "{:.10g}".format,
Headers.CONNECTION_FACTOR: "{:.10g}".format,
"CONNECTION_FACTOR": "{:.10g}".format,
Copy link
Collaborator

Choose a reason for hiding this comment

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

Add header variations to Headers in constants.py and use them from there?
Maybe add a default format to the headers as well and get them from there?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

See: #168

completor/prepare_outputs.py Show resolved Hide resolved
completor/prepare_outputs.py Outdated Show resolved Hide resolved
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.

Respect reservoir simulators 132 char width limit
2 participants