Help users visualising the geometry, add info to the docs

[shimwell]

There are a few ways of visualising the geometry

In no particular order here are a few options and perhaps we should add information to the docs on these.

Option 1, export STEP, BREP, BIN, STL file and open with FreeCAD or another cad software (paraview can also open stl files) paramak reactors return assembly objects. More details in cadquery docs https://cadquery.readthedocs.io/en/latest/importexport.html

assembly.export('my_model.step') # deprecated
assembly.export('my_model.step')
assembly.export('my_model.stl')
assembly.toCompound().exportBrep('my_model.brep') # brep needs to be compounded first
assembly.toCompound().exportBin('my_model.brep') # brep needs to be compounded first, binary brep in latest cadquery master branch

Option 2 export as SVG image https://cadquery.readthedocs.io/en/latest/importexport.html#exporting-svg

Option 3 export as png image using the plugin https://github.com/jmwright/cadquery-png-plugin

Option 4 export as portable interactive html using jupyter-cadquery https://github.com/bernhard-42/jupyter-cadquery and open in web browser

from jupyter_cadquery import show
view = show(assembly)
view.export_html('my_model.html')

Option 5 make use of cq-editor https://github.com/CadQuery/CQ-editor

Option 6 use the cadquery vscode plugin https://marketplace.visualstudio.com/items?itemName=roipoussiere.cadquery

Option 7 Use the inbuild cadquery vtk viewer

from cadquery.vis import show
show(assembly)