Merge pull request #272 from fusion-energy/develop

general updates from develop branch

Dockerfile

@@ -70,7 +70,7 @@ FROM dependencies as final
 ARG paramak_version=develop
 
 COPY run_tests.sh run_tests.sh
-COPY paramak paramak/
+COPY src src/
 COPY examples examples/
 
 COPY tests tests/

conda/meta.yaml

@@ -14,8 +14,8 @@ build:
 requirements:
   build:
     - python {{ python }}
-    - setuptools>=46.4.0
-    - setuptools_scm>=6.3.1
+    - setuptools>=65.4.1
+    - setuptools_scm>=7.0.5
   run:
     - python {{ python }}
     - cadquery {{ cadquery }}

examples/example_parametric_reactors/render_of_random_reactor_render_with_text_gif.py

@@ -0,0 +1,134 @@
+# This examples creates Gif animation of 50 reactors by creating individual
+# images of reactors and stiching them together using Imagemagick into a Gif
+# animation. Two animations are made, of of a 3D render and one of a wireframe
+# line drawing.
+
+import math
+import os
+
+# to run this example you will need all of the following packages installed
+import matplotlib.pyplot as plt
+import numpy as np
+import paramak
+import pyrender
+import trimesh
+from PIL import Image, ImageFont, ImageDraw
+
+
+def create_reactor_renders(
+    render_number,
+    inner_blanket_radius,
+    blanket_thickness,
+    blanket_height,
+    lower_blanket_thickness,
+    upper_blanket_thickness,
+    blanket_vv_gap,
+    upper_vv_thickness,
+    vv_thickness,
+    lower_vv_thickness,
+):
+
+    # creates a blank figure for populating with subplots
+    plt.figure()
+
+    # creates a reactor from the input arguments
+    my_reactor = paramak.FlfSystemCodeReactor(
+        rotation_angle=180,
+        inner_blanket_radius=inner_blanket_radius,
+        blanket_thickness=blanket_thickness,
+        blanket_height=blanket_height,
+        lower_blanket_thickness=lower_blanket_thickness,
+        upper_blanket_thickness=upper_blanket_thickness,
+        blanket_vv_gap=blanket_vv_gap,
+        upper_vv_thickness=upper_vv_thickness,
+        vv_thickness=vv_thickness,
+        lower_vv_thickness=lower_vv_thickness,
+    )
+
+    # saves the reactor geometry as separate stl files that are later read in
+    # for the rendering
+    my_reactor.export_stl()
+
+    # assigns colours to each stl file
+    stl_files_with_colors = {
+        "blanket.stl": (255, 255, 0),
+        "vessel.stl": (128, 128, 128),
+        "upper_blanket.stl": (255, 255, 0),
+        "lower_blanket.stl": (255, 255, 0),
+        "lower_vessel.stl": (128, 128, 128),
+        "upper_vessel.stl": (128, 128, 128),
+    }
+
+    scene = pyrender.Scene()
+
+    # for each stl file and color combination
+    for key, value in stl_files_with_colors.items():
+        trimesh_obj = trimesh.load(key)
+        trimesh_obj.visual.vertex_colors = value
+        trimesh_obj.visual
+
+        render_mesh = pyrender.Mesh.from_trimesh(trimesh_obj, smooth=False)
+        scene.add(render_mesh)
+
+    camera = pyrender.camera.PerspectiveCamera(yfov=math.radians(90.0))  # aspectRatio=2.0 could be added here
+
+    # sets the position of the camera using a matrix
+    cam = 2**-0.5
+    camera_pose = np.array([[1, 0, 0, 0], [0, cam, -cam, -600], [0, cam, cam, 600], [0, 0, 0, 1]])
+
+    # adds a camera and a point light source at the same location
+    scene.add(camera, pose=camera_pose)
+    light = pyrender.PointLight(color=np.ones(3), intensity=300000.0)
+    scene.add(light, pose=camera_pose)
+
+    # renders the scene
+    my_render = pyrender.OffscreenRenderer(1000, 1000)
+    color, _ = my_render.render(scene)
+
+    # adds the render to the plot as a subplot in the correct location
+    plt.plot()
+    plt.axis("off")
+    plt.imshow(color)
+    # plt.show()
+    plt.savefig("tempfile.png", dpi=400)
+
+    my_image = Image.open("tempfile.png")
+    title_text = f"""
+    inner_blanket_radius={round(inner_blanket_radius,1)}
+    blanket_thickness={round(blanket_thickness,1)}
+    blanket_height={round(blanket_height,1)}
+    lower_blanket_thickness={round(lower_blanket_thickness,1)}
+    upper_blanket_thickness={round(upper_blanket_thickness,1)}
+    blanket_vv_gap={round(blanket_vv_gap,1)}
+    upper_vv_thickness={round(upper_vv_thickness,1)}
+    vv_thickness={round(vv_thickness,1)}
+    lower_vv_thickness={round(lower_vv_thickness,1)}
+    """
+    image_editable = ImageDraw.Draw(my_image)
+
+    # ttf file from https://fonts.google.com/
+    title_font = ImageFont.truetype("EncodeSansSemiExpanded-Medium.ttf", 50)
+    xy_location = (1000, 1000)
+    rgb = (0, 0, 0)
+    image_editable.text(xy_location, title_text, rgb, font=title_font)
+    my_image.save(f"render_{str(render_number).zfill(3)}.png")
+
+
+# loops through adding a random reactor render to the figure with each iteration
+for i in range(50):
+    create_reactor_renders(
+        render_number=i,
+        inner_blanket_radius=np.random.uniform(low=50, high=90),
+        blanket_thickness=np.random.uniform(low=50, high=140),
+        blanket_height=np.random.uniform(low=400, high=550),
+        lower_blanket_thickness=np.random.uniform(low=20, high=70),
+        upper_blanket_thickness=np.random.uniform(low=20, high=70),
+        blanket_vv_gap=np.random.uniform(low=10, high=90),
+        upper_vv_thickness=np.random.uniform(low=5, high=15),
+        vv_thickness=np.random.uniform(low=5, high=15),
+        lower_vv_thickness=np.random.uniform(low=5, high=15),
+    )
+
+# The convert comand requires imagemagick
+# saves the rendered png files as a gif
+os.system("convert -delay 40 -loop 0 render_*.png reactors.gif")

pyproject.toml

@@ -1,13 +1,48 @@
 [build-system]
 requires = [
-    "setuptools >= 46.4.0",
-    "wheel",
-    "setuptools_scm[toml] >= 6.3.1",
+    "setuptools >= 65.4.1",
+    "setuptools_scm[toml] >= 7.0.5",
 ]
 build-backend = "setuptools.build_meta"
 
+[project]
+name = "paramak"
+dynamic = ["version"]
+description = "Create 3D fusion reactor CAD models based on input parameters"
+readme = "README.md"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+authors = [
+  { name="The Paramak Development Team" },
+]
+license = {file = "LICENSE.txt"}
+requires-python = ">=3.8"
+dependencies = [
+    "plotly>=5.1.0",
+    "scipy>=1.7.0",
+    "sympy>=1.8",
+    "numpy>=1.21.1",
+    "matplotlib>=3.4.2",
+    "plasmaboundaries>=0.1.8",
+    "jupyter-client < 7",
+    "jupyter-cadquery>=3.2.0",
+    "brep_part_finder>=0.5.0",
+    "brep_to_h5m>=0.4.0",
+]
+
+[project.urls]
+"Homepage" = "https://github.com/fusion-energy/paramak"
+"Bug Tracker" = "https://github.com/fusion-energy/paramak/issues"
+"Documentation" = "https://paramak.readthedocs.io"
+
 [tool.setuptools_scm]
-write_to = "paramak/_version.py"
+write_to = "src/_version.py"
 
 [tool.black]
 line-length = 120
+
+[tool.setuptools]
+package-dir = {"" = "src"}

setup.cfg

@@ -1,43 +1,10 @@
 [metadata]
-name = paramak
 version = attr: paramak.__version__
 author = The Paramak Development Team
 author_email = [email protected]
-description = Create 3D fusion reactor CAD models based on input parameters
 long_description = file: README.md
 long_description_content_type = text/markdown
-url = https://github.com/fusion-energy/paramak
-license = MIT
-license_file = LICENSE.txt
-classifiers =
-    Natural Language :: English
-    Topic :: Scientific/Engineering
-    Programming Language :: Python :: 3
-    Programming Language :: Python :: 3.6
-    Programming Language :: Python :: 3.7
-    Programming Language :: Python :: 3.8
-    Programming Language :: Python :: 3.9
-    License :: OSI Approved :: MIT License
-    Operating System :: OS Independent
-project_urls =
-    Source = https://github.com/fusion-energy/paramak
-    Tracker = https://github.com/fusion-energy/paramak/issues
 
-[options]
-packages = find:
-python_requires= >=3.8
-install_requires=
-    plotly >= 5.1.0
-    scipy >= 1.7.0
-    sympy >= 1.8
-    numpy >= 1.21.1
-    matplotlib >= 3.4.2
-    plasmaboundaries >= 0.1.8
-    jupyter-client < 7
-    jupyter-cadquery >= 3.2.0
-    brep_part_finder >= 0.5.0
-    brep_to_h5m >= 0.4.0
-    setuptools_scm
 
 [options.extras_require]
 tests =

paramak/parametric_components/dished_vacuum_vessel.py → src/paramak/parametric_components/dished_vacuum_vessel.py

@@ -1,3 +1,4 @@
+from cadquery import Compound
 from paramak import RotateMixedShape, CenterColumnShieldCylinder, ConstantThicknessDome
 
 
@@ -117,5 +118,5 @@ def create_solid(self):
             rotation_angle=self.rotation_angle,
         )
 
-        upper_dome_section.solid = upper_dome_section.solid.union(cylinder_section.solid)
-        self.solid = lower_dome_section.solid.union(upper_dome_section.solid)
+        shapes = [lower_dome_section.solid.val(), upper_dome_section.solid.val(), cylinder_section.solid.val()]
+        self.solid = Compound.makeCompound(shapes)