Missing 3d models for several componets

shimwell commented 3 years ago

We could do with 3d models for some of the missing components.

I don't think we should do every component but could do with updating the /docs/source/paramak.parametric_components.rst file for the following components:

[ ] VacuumVesselInnerLeg
[ ] CuttingWedge
[ ] HexagonPin example here
[ ] ITERtypeDivertor example here
[ ] ITERtypeDivertorNoDome
[ ] InnerTfCoilsCircular
[x] InnerTfCoilsFlat
[x] PoloidalFieldCoil
[ ] PoloidalFieldCoilFP
[ ] PoloidalFieldCoilSet
[ ] PoloidalFieldCoilCase
[ ] PoloidalFieldCoilCaseFC
[ ] PoloidalFieldCoilCaseSet
[ ] PoloidalFieldCoilCaseSetFC
[x] PoloidalSegmenter
[x] PortCutterRotated example here
[x] PortCutterRectangular example here
[x] PortCutterCircular example here
[x] Plasma
[ ] PlasmaFromPoints
[x] PlasmaBoundaries
[ ] TFCoilCasing
[ ] ToroidalFieldCoilRectangle
[ ] ToroidalFieldCoilCoatHanger
[ ] ToroidalFieldCoilPrincetonD
[ ] ToroidalFieldCoilTripleArc
[ ] RotatedTrapezoid
[ ] RotatedIsoscelesTriangle
[x] VacuumVessel
[x] VacuumVesselInnerLeg example here

In each case the following code will need adding

.. cadquery::
   :select: cadquery_object
   :gridsize: 0

   import paramak
   my_component = paramak.ComponentNameHere(
         ComponentArgumentsHere=Values,
         ComponentArgumentsHere=Values,
         ComponentArgumentsHere=Values,
   )

   cadquery_object = my_component.solid

Where ComponentNameHere, ComponentArgumentsHere and Values have been replaced with the component specific arguments that can be found in the examples

For an example of what is expected for each component take a look at this example PR

PRs for single components on this checklist are most welcome

shimwell commented 3 years ago

I couldn't see examples for these in the examples folder. Might need to grab examples from the tests or make new examples for these components BlanketCutterParallels PoloidalFieldCoilFP BlanketCutterStar CoolantChannelRingCurved CuttingWedge ITERtypeDivertorNoDome PlasmaFromPoints TFCoilCasing ToroidalFieldCoilRectangle ToroidalFieldCoilCoatHanger

husni-zuhdi commented 1 year ago

Hi @shimwell, I'm a newbie to the open-source community and want to get started. Can I work on several components on this issue? Thanks

shimwell commented 1 year ago

That would be great, I would double check the docs to see if the diagrams are missing for the model just to be sure.

fusion-energy / paramak

Missing 3d models for several componets #30