Develop

[shimwell]

Proposed changes

This is the v0.02 release with planned features implemented from the project board https://github.com/ukaea/paramak/projects/2

This is the second release of the project and is being merged to main just before the pullrequest.com review is completed. The next version will include some improvements from the pullrequest.com review

Breaking hange

- RENAMED NeutronicsModelFromReactor to NeutronicsModel and replaced the reactor arg name with geometry

These include:

• a check for stl flename duplication in the reactor
• adding a htc reactor to the examples
• fixing attribute setting bugs and missing documentation in the attribute checking for blanketcutterparallels
• Added a radi check to the CenterCoumnShieldFlatTopHyperbol

In addition to these planned features and improvements there were some additional improvements:

• Adding neutronics simulations to the CI on circle and github actions

• Adding optional neutronics to the dockerfile as a build arg

• Adding a (award winning) video presentation to the readme and docs
  added new paramentric component:
  -- CoolantChannelRingStraight
  -- CoolantChannelRingCurved
  -- RotatedTrapezoid
  -- RotatedIsoscelesTriangle
  -- ShellFS
  -- HollowCube (refactoring of the graveyard)

• refactored the export to h5m via the pymoab route so that shapes can be exported as well as reactors

• lots and lots of new tests and an increased code coverage

• reactors and shapes now have a largest_dimension which helps with the DAGMC - graveyard refactoring

• Shapes now have a .wire attribute and this can be exported via the export_stp(mode='wire')

• improved documentation on the VacuumVesselstp, neutronics model

• added an example of a component based parameter study in neutronics

• Improved ToroidalFieldCoilPrincetonDsvg images in docs

Types of changes

What types of changes does your code introduce to the Paramak?
Put an x in the boxes that apply

• 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

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

• Pep8 applied
• 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)

Further comments

If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...

[codecov]

Codecov Report

Merging #638 (51960ed) into main (f807d88) will increase coverage by 6.91%.
The diff coverage is 95.79%.

@@            Coverage Diff             @@
##             main     #638      +/-   ##
==========================================
+ Coverage   91.68%   98.59%   +6.91%     
==========================================
  Files          63       68       +5     
  Lines        3607     4125     +518     
==========================================
+ Hits         3307     4067     +760     
+ Misses        300       58     -242     

Impacted Files	Coverage Δ
...ric_components/blanket_constant_thickness_arc_v.py	100.00% <ø> (ø)
...amak/parametric_components/blanket_cutters_star.py	100.00% <ø> (ø)
...ak/parametric_components/center_column_circular.py	100.00% <ø> (ø)
...k/parametric_components/inner_tf_coils_circular.py	100.00% <ø> (ø)
...ametric_components/poloidal_field_coil_case_set.py	98.27% <ø> (+1.72%)	⬆️
...k/parametric_components/poloidal_field_coil_set.py	100.00% <ø> (ø)
...aramak/parametric_components/poloidal_segmenter.py	100.00% <ø> (ø)
...tric_components/toroidal_field_coil_coat_hanger.py	100.00% <ø> (ø)
...etric_components/toroidal_field_coil_triple_arc.py	100.00% <ø> (ø)
paramak/parametric_reactors/ball_reactor.py	100.00% <ø> (ø)
... and 73 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 f807d88...51960ed. Read the comment docs.