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

Refactor output #170

Merged
merged 15 commits into from
May 19, 2024
Merged

Refactor output #170

merged 15 commits into from
May 19, 2024

Conversation

keurfonluu
Copy link
Owner

  • Changed: dedicated output classes (toughio.ElementOutput and toughio.ConnectionOutput) instead of mere namedtuple toughio.Output.
  • Added: option time_steps to read a specific time step to avoid having to read the whole output file when working on a specific time step (so faster).
  • Fixed: standard output reader for outputs generated by early versions of TOUGH2.

Reminders:

  • Run invoke format to make sure the code follows the style guide,
  • Add tests for new features or tests that would have caught the bug that you're fixing,
  • Write detailed docstrings for all functions, classes and/or methods,
  • If adding new functionality, unit test it and add it to the documentation.

Copy link

codecov bot commented May 19, 2024

Codecov Report

Attention: Patch coverage is 86.09272% with 42 lines in your changes are missing coverage. Please review.

Project coverage is 90.20%. Comparing base (4894d6d) to head (636014e).
Report is 16 commits behind head on master.

Files Patch % Lines
toughio/_io/output/_common.py 73.33% 24 Missing ⚠️
toughio/_io/output/tough/_tough.py 90.38% 5 Missing ⚠️
toughio/_io/output/_helpers.py 80.00% 4 Missing ⚠️
toughio/_io/output/petrasim/_petrasim.py 92.10% 3 Missing ⚠️
toughio/_cli/_export.py 60.00% 2 Missing ⚠️
toughio/_io/output/csv/_csv.py 95.34% 2 Missing ⚠️
toughio/_mesh/_mesh.py 71.42% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master     #170      +/-   ##
==========================================
- Coverage   90.21%   90.20%   -0.01%     
==========================================
  Files          97       97              
  Lines        6283     6433     +150     
==========================================
+ Hits         5668     5803     +135     
- Misses        615      630      +15     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@keurfonluu keurfonluu merged commit 3d6476d into master May 19, 2024
7 of 9 checks passed
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.

1 participant