cad-to-dagmc 0.7.5__py3-none-any.whl → 0.7.7__py3-none-any.whl

_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.7.5'
-__version_tuple__ = version_tuple = (0, 7, 5)
+__version__ = version = '0.7.7'
+__version_tuple__ = version_tuple = (0, 7, 7)

cad_to_dagmc/core.py

@@ -5,6 +5,7 @@ import numpy as np
 from cadquery import importers
 from pymoab import core, types
 import tempfile
+import warnings
 
 
 def _define_moab_core_and_tags() -> tuple[core.Core, dict]:
@@ -76,6 +77,7 @@ def _vertices_to_h5m(
         triangles:
         material_tags:
         h5m_filename:
+        implicit_complement_material_tag:
     """
 
     if len(material_tags) != len(triangles_by_solid_by_face):
@@ -184,7 +186,15 @@ def _vertices_to_h5m(
 
     moab_core.add_entities(file_set, all_sets)
 
-    moab_core.write_file(h5m_filename)
+    # makes the folder if it does not exist
+    if Path(h5m_filename).parent:
+        Path(h5m_filename).parent.mkdir(parents=True, exist_ok=True)
+
+    # moab_core.write_file only accepts strings
+    if isinstance(h5m_filename, Path):
+        moab_core.write_file(str(h5m_filename))
+    else:
+        moab_core.write_file(h5m_filename)
 
     print(f"written DAGMC file {h5m_filename}")
 
@@ -230,8 +240,7 @@ def _mesh_brep(
     mesh_algorithm: int = 1,
     dimensions: int = 2,
 ):
-    """Creates a conformal surface meshes of the volumes in a Brep file using
-    Gmsh.
+    """Creates a conformal surface meshes of the volumes in a Brep file using Gmsh.
 
     Args:
         occ_shape: the occ_shape of the Brep file to convert
@@ -339,6 +348,12 @@ def _check_material_tags(material_tags, iterable_solids):
             if not isinstance(material_tag, str):
                 msg = f"material_tags should be an iterable of strings."
                 raise ValueError(msg)
+            if len(material_tag) > 28:
+                msg = (
+                    f"Material tag {material_tag} is too long. DAGMC will truncate this material tag "
+                    f"to 28 characters. The resulting tag in the h5m file will be {material_tag[:28]}"
+                )
+                warnings.warn(msg)
 
 
 def order_material_ids_by_brep_order(original_ids, scrambled_id, material_tags):
@@ -357,6 +372,7 @@ class MeshToDagmc:
 
     # TODO add export_unstructured_mesh_file
     # TODO add add_gmsh_msh_file
+    # TODO test for exports result in files
 
     def export_dagmc_h5m_file(
         self,
@@ -530,6 +546,8 @@ class CadToDagmc:
                 The gmsh object after finalizing the mesh.
         """
 
+        # gmesh writes out a vtk file that is accepted by openmc.UnstructuredMesh
+        # The library argument must be set to "moab"
         if Path(filename).suffix != ".vtk":
             raise ValueError("Unstructured mesh filename must have a .vtk extension")
 
@@ -554,9 +572,15 @@ class CadToDagmc:
             dimensions=3,
         )
 
-        # gmesh writes out a vtk file that is accepted by openmc.UnstructuredMesh
-        # The library argument must be set to "moab"
-        gmsh.write(filename)
+        # makes the folder if it does not exist
+        if Path(filename).parent:
+            Path(filename).parent.mkdir(parents=True, exist_ok=True)
+
+        # gmsh.write only accepts strings
+        if isinstance(filename, Path):
+            gmsh.write(str(filename))
+        else:
+            gmsh.write(filename)
 
         gmsh.finalize()
 
@@ -621,7 +645,15 @@ class CadToDagmc:
             dimensions=dimensions,
         )
 
-        gmsh.write(filename)
+        # makes the folder if it does not exist
+        if Path(filename).parent:
+            Path(filename).parent.mkdir(parents=True, exist_ok=True)
+
+        # gmsh.write only accepts strings
+        if isinstance(filename, Path):
+            gmsh.write(str(filename))
+        else:
+            gmsh.write(filename)
 
         print(f"written GMSH mesh file {filename}")
 

{cad_to_dagmc-0.7.5.dist-info → cad_to_dagmc-0.7.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: cad_to_dagmc
-Version: 0.7.5
+Version: 0.7.7
 Summary: Converts CAD files to a DAGMC h5m file
 Author-email: Jonathan Shimwell <mail@jshimwell.com>
 Project-URL: Homepage, https://github.com/fusion-energy/cad_to_dagmc
@@ -14,8 +14,8 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: trimesh
 Requires-Dist: networkx
-Requires-Dist: cadquery>=2.4.0
-Requires-Dist: numpy<=1.26.4
+Requires-Dist: cadquery>=2.5.2
+Requires-Dist: numpy
 Requires-Dist: gmsh
 Provides-Extra: tests
 Requires-Dist: pytest; extra == "tests"
@@ -35,17 +35,25 @@ Requires-Dist: vtk; extra == "tests"
 [![PyPI](https://img.shields.io/pypi/v/cad_to_dagmc?color=brightgreen&label=pypi&logo=grebrightgreenen&logoColor=green)](https://pypi.org/project/cad_to_dagmc/)
 
 
-A minimal package that converts CAD geometry to [DAGMC](https://github.com/svalinn/DAGMC/) h5m files
+A minimal package that converts CAD geometry to [DAGMC](https://github.com/svalinn/DAGMC/) compatible meshes
 
-cad-to-dagmc can create:
+cad-to-dagmc can create DAGMC compatible:
 - surface meshes / faceted geometry / triangular meshes
 - unstructured mesh / tetrahedral meshes / volume meshes
 
-cad-to-dagmc can convert:
+cad-to-dagmc can convert the following in to DAGMC compatible meshes:
 - STEP files
-- CadQuery objects (in memory)
+- CadQuery objects
+- Gmsh meshes
 
-cad-to-dagmc aims to produce DAGMC compatible h5m files from CAD geometry is intended to convert [STEP](http://www.steptools.com/stds/step/) files or [CadQuery](https://cadquery.readthedocs.io) objects to a [DAGMC](https://github.com/svalinn/DAGMC/) compatible h5m file.
+Options include
+- Ability to scale the output mesh (e.g from meters to cm)
+- Ability to skip imprinting stage
+- Specify meshing parameters for finer or coarser meshes or change the mesh algorithm
+- Ability to specify a material tag for the DAGMC implicit complement
+- Pass objects from CadQuery in memory (without writting to disk)
+
+cad-to-dagmc aims to produce DAGMC compatible h5m and vtk files from CAD geometry is intended to convert [STEP](http://www.steptools.com/stds/step/) files, [CadQuery](https://cadquery.readthedocs.io) or [Gmsh]([https://cadquery.readthedocs.io](https://gmsh.info/)) meshes objects to a [DAGMC](https://github.com/svalinn/DAGMC/) compatible h5m file or a DAGMC compatible Unstruuctre vtk file.
 
 The resulting DAGMC geometry can then be used for simulations in [OpenMC](https://github.com/openmc-dev/openmc/) or [other supported codes](https://svalinn.github.io/DAGMC/).
 
@@ -146,7 +154,7 @@ You may also want to install OpenMC with DAGMC to make use of the h5m geometry f
 
 To install OpenMC you can run ```mamba install -c conda-forge openmc``` however this more specific command makes sure the latest version of OpenMC which contains DAGMC is chosen by conda / mamba
 ```bash
-mamba install -c conda-forge -y "openmc=0.14.0=dagmc*nompi*"
+mamba install -c conda-forge -y "openmc=0.15.0=dagmc*nompi*"
 ```
 
 It might not be possible to install OpenMC and cad-to-dagmc in the same conda/mamba python environment so you may have to create a new conda/mamba environment and install OpenMC there.
@@ -160,15 +168,11 @@ The package requires newer versions of Linux. For example the package does not w
 
 The package requires newer versions of pip. It is recommended to ensure that your version of pip is up to date. This can be done with ```python -m pip install --upgrade pip```
 
-Installing one of the package dependancies (gmsh) with pip appears to result in errors when passing cad objects in memory between cadquery / ocp and gmsh. The default method of passing cad objects is via file so this should not impact most users. The conda install gmsh appears to work fine with in memory passing of cad objects as the version of OCP matches between Gmsh and CadQuery.
-
-
-# Usage - creation of DAGMC h5m files
+Installing one of the package dependancies (Gmsh) with pip appears to result in errors when passing cad objects in memory between cadquery / ocp and gmsh. The default method of passing cad objects is via file so this should not impact most users. The conda install gmsh appears to work fine with in memory passing of cad objects as the version of OCP matches between Gmsh and CadQuery.
 
-For examples see the [examples folder](https://github.com/fusion-energy/cad_to_dagmc/tree/main/examples)
 
-# Usage - simulation with transport code
+# Usage
 
-For examples see the [examples folder](https://github.com/fusion-energy/cad_to_dagmc/tree/main/examples)
+For examples showing creation of DAGMC h5m files, vtk files and usage within OpenMC transport code see the [examples folder](https://github.com/fusion-energy/cad_to_dagmc/tree/main/examples)
 
 For more examples see the CAD tasks in the [neutronics-workshop](https://github.com/fusion-energy/neutronics-workshop) and [model benchmark zoo](https://github.com/fusion-energy/model_benchmark_zoo)

cad_to_dagmc-0.7.7.dist-info/RECORD

@@ -0,0 +1,8 @@
+_version.py,sha256=OFzKtYPiFCCvMWwWVN3UDiEwBAcWMPY3Atug8b0zLFk,411
+cad_to_dagmc/__init__.py,sha256=fskHUTyCunSpnpJUvBfAYjx4uwDKXHTTiMP6GqnFRf0,494
+cad_to_dagmc/core.py,sha256=5xWb8oGRs6318CcUI_PADsF1vJjqzYPVNAQ8vKGjZE4,29063
+cad_to_dagmc-0.7.7.dist-info/LICENSE,sha256=B8kznH_777JVNZ3HOKDc4Tj24F7wJ68ledaNYeL9sCw,1070
+cad_to_dagmc-0.7.7.dist-info/METADATA,sha256=rGXnqaOFnpf4mXTn-BN9uXi8d3dwBt7SzcP5Ornd18o,8362
+cad_to_dagmc-0.7.7.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+cad_to_dagmc-0.7.7.dist-info/top_level.txt,sha256=zTi8C64SEBsE5WOtPovnxhOzt-E6Oc5nC3RW6M_5aEA,22
+cad_to_dagmc-0.7.7.dist-info/RECORD,,

{cad_to_dagmc-0.7.5.dist-info → cad_to_dagmc-0.7.7.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.6.0)
+Generator: setuptools (75.8.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

cad_to_dagmc-0.7.5.dist-info/RECORD

@@ -1,8 +0,0 @@
-_version.py,sha256=AfxYsOLHf-d9Yv9B0Y-QKGSJPkQBqceXnCr_lUKXMKM,411
-cad_to_dagmc/__init__.py,sha256=fskHUTyCunSpnpJUvBfAYjx4uwDKXHTTiMP6GqnFRf0,494
-cad_to_dagmc/core.py,sha256=AfYKmrGCFcXZnsxCW72rdSAJY4kvffk1MTG4uURH-cw,27768
-cad_to_dagmc-0.7.5.dist-info/LICENSE,sha256=B8kznH_777JVNZ3HOKDc4Tj24F7wJ68ledaNYeL9sCw,1070
-cad_to_dagmc-0.7.5.dist-info/METADATA,sha256=okv56zxnjveO_HMC58bd8gO27vLZ_TXKsY5r1N0hVpw,7937
-cad_to_dagmc-0.7.5.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-cad_to_dagmc-0.7.5.dist-info/top_level.txt,sha256=zTi8C64SEBsE5WOtPovnxhOzt-E6Oc5nC3RW6M_5aEA,22
-cad_to_dagmc-0.7.5.dist-info/RECORD,,