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

Add error message when no final time is provided in transient simulations #769

Conversation

RemDelaporteMathurin
Copy link
Collaborator

Proposed changes

As described in this Discourse topic when users don't provide final_time to settings when running a transient simulation, the error is not explanatory.

This PR simply adds a check to initialise() and raises a dedicated error message.

Types of changes

What types of changes does your code introduce to FESTIM?

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Code refactoring
  • Documentation Update (if none of the other choices apply)
  • New tests

Checklist

  • Black formatted
  • Unit tests pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

@RemDelaporteMathurin RemDelaporteMathurin added the enhancement New feature or request label May 31, 2024
@RemDelaporteMathurin RemDelaporteMathurin added this to the v1.3 milestone May 31, 2024
Copy link

codecov bot commented May 31, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.51%. Comparing base (315aebd) to head (38677a7).
Report is 225 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #769   +/-   ##
=======================================
  Coverage   99.51%   99.51%           
=======================================
  Files          58       58           
  Lines        2476     2478    +2     
=======================================
+ Hits         2464     2466    +2     
  Misses         12       12           

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

Copy link
Collaborator

@jhdark jhdark left a comment

Choose a reason for hiding this comment

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

Looks good to me

@RemDelaporteMathurin RemDelaporteMathurin merged commit cc62108 into festim-dev:main May 31, 2024
5 checks passed
@RemDelaporteMathurin RemDelaporteMathurin deleted the error-message-final-time branch May 31, 2024 08:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants