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

Simulation settings check - Unrecognised settings raise Error #148

Merged
merged 32 commits into from
May 19, 2021

Conversation

ngoiz
Copy link
Contributor

@ngoiz ngoiz commented May 10, 2021

Big functionality check with SHARPy checking that the simulation settings are correct or else raising an error. This feature is implemented with 2 main objectives in mind:

  1. Clean up simulation files with endless deprecated settings that where being copied and passed on from sim to sim
  2. Catch typos in settings that would mean SHARPy ignores that setting. It would previously throw a warning but we know how easy those are to miss. This means bye bye typo-induced head scratching of why this isn't doing what it is supposed to do.

Since it has been a collective effort getting all of this updated, please could you all have a look (obviously at files you personally haven't modified :) ). Thanks for all the work getting all those legacy cases and examples up to date!

@ngoiz ngoiz requested review from ArturoMS13 and sduess May 10, 2021 18:07
@ngoiz ngoiz changed the base branch from master to develop May 10, 2021 20:34
- add output function to base class to reuse in child classes
Copy link
Collaborator

@sduess sduess left a comment

Choose a reason for hiding this comment

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

Nice work and thanks for the useful contribution to SHARPy! I have just added a minor change to exceptions.py to avoid some duplicate code. The rest looks good to me!

@codecov-commenter
Copy link

Codecov Report

Merging #148 (817c6b7) into develop (f9d04bc) will increase coverage by 0.12%.
The diff coverage is 83.33%.

Impacted file tree graph

@@             Coverage Diff             @@
##           develop     #148      +/-   ##
===========================================
+ Coverage    61.70%   61.83%   +0.12%     
===========================================
  Files          124      123       -1     
  Lines        22508    22479      -29     
===========================================
+ Hits         13889    13900      +11     
+ Misses        8619     8579      -40     
Impacted Files Coverage Δ
sharpy/presharpy/presharpy.py 82.35% <0.00%> (-3.02%) ⬇️
sharpy/generators/gustvelocityfield.py 61.80% <50.00%> (+0.98%) ⬆️
sharpy/utils/settings.py 82.26% <50.00%> (-0.77%) ⬇️
sharpy/utils/exceptions.py 66.66% <61.53%> (+4.44%) ⬆️
sharpy/generators/bumpvelocityfield.py 65.67% <100.00%> (+0.52%) ⬆️
sharpy/generators/dynamiccontrolsurface.py 65.00% <100.00%> (+0.89%) ⬆️
sharpy/generators/floatingforces.py 24.00% <100.00%> (+0.15%) ⬆️
sharpy/generators/gridbox.py 48.52% <100.00%> (+0.76%) ⬆️
sharpy/generators/helicoidalwake.py 98.30% <100.00%> (+0.01%) ⬆️
sharpy/generators/modifystructure.py 37.28% <100.00%> (+0.53%) ⬆️
... and 13 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f9d04bc...817c6b7. Read the comment docs.

Copy link
Contributor

@ArturoMS13 ArturoMS13 left a comment

Choose a reason for hiding this comment

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

Thanks for all the contributions!

@ngoiz ngoiz merged commit 536d8fd into develop May 19, 2021
@ngoiz ngoiz deleted the dev_setting_error branch May 19, 2021 11:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants