cad-to-dagmc 0.5.0__tar.gz → 0.5.1__tar.gz

{cad_to_dagmc-0.5.0 → cad_to_dagmc-0.5.1}/.github/workflows/black.yml

@@ -13,7 +13,7 @@ jobs:
   black:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       with:
         ref: ${{ github.head_ref }}
     - name: Setup Python
@@ -26,7 +26,7 @@ jobs:
         pip install black
     - name: Run black
       run: |
-        black .
+        black --line-length 100 .
     - uses: stefanzweifel/git-auto-commit-action@v4
       with:
         commit_message: "[skip ci] Apply formatting changes"

cad_to_dagmc-0.5.1/.github/workflows/ci_with_benchmarks.yml

@@ -0,0 +1,48 @@
+
+name: CI with model benchmark zoo
+
+on:
+  pull_request:
+    branches:
+      - main
+    paths-ignore:
+      - 'docs/**'
+      - '.gitignore'
+      - '*.md'
+      - 'CITATION.cff'
+      - 'LICENSE.txt'
+      - 'readthedocs.yml'
+  push:
+    branches:
+      - main
+
+jobs:
+  testing:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: install non pypi dependencies for cad creation
+        env:
+          OPENMC_CROSS_SECTIONS: /home/runner/work/cad_to_dagmc/cad_to_dagmc/cross_sections.xml
+        shell: bash
+        run: |
+          wget -O Miniforge3.sh "https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-$(uname)-$(uname -m).sh"
+          bash Miniforge3.sh -b -p "${HOME}/conda"
+          source "${HOME}/conda/etc/profile.d/conda.sh"
+          source "${HOME}/conda/etc/profile.d/mamba.sh"
+          sudo apt-get --allow-releaseinfo-change update
+          sudo apt-get update -y
+          sudo apt-get upgrade -y
+          sudo apt-get install -y libgl1-mesa-glx libgl1-mesa-dev libglu1-mesa-dev freeglut3-dev libosmesa6 libosmesa6-dev libgles2-mesa-dev libarchive-dev libpangocairo-1.0-0
+          mamba activate
+          mamba install -y -c cadquery -c conda-forge moab gmsh python-gmsh cadquery=master "openmc=0.13.3=dagmc*nompi*"
+          mamba install -y -c conda-forge "openmc=0.13.3=dagmc*nompi*"
+          python -m pip install --upgrade pip
+          python -m pip install cad_to_dagmc openmc_data_downloader
+          openmc_data_downloader -l ENDFB-7.1-NNDC -i Fe56 Be9
+          git clone https://github.com/fusion-energy/model_benchmark_zoo.git
+          cd model_benchmark_zoo
+          python -m pip install .[tests]
+          pytest tests/test_cad_to_dagmc -v

cad_to_dagmc-0.5.1/.github/workflows/ci_with_install.yml

@@ -0,0 +1,63 @@
+
+# This CI will launch a Docker image that contains all the dependencies required
+# within that image the pytest test suite is run 
+# container:
+#       image: continuumio/miniconda3:23.3.1-0
+
+name: CI with install
+
+on:
+  pull_request:
+    branches:
+      - main
+    paths-ignore:
+      - 'docs/**'
+      - '.gitignore'
+      - '*.md'
+      - 'CITATION.cff'
+      - 'LICENSE.txt'
+      - 'readthedocs.yml'
+  push:
+    branches:
+      - main
+
+jobs:
+  testing:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      # - uses: conda-incubator/setup-miniconda@v2
+
+      - name: install non pypi dependencies
+        shell: bash
+        run: |
+          wget -O Miniforge3.sh "https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-$(uname)-$(uname -m).sh"
+          bash Miniforge3.sh -b -p "${HOME}/conda"
+          source "${HOME}/conda/etc/profile.d/conda.sh"
+          source "${HOME}/conda/etc/profile.d/mamba.sh"
+          sudo apt-get --allow-releaseinfo-change update
+          sudo apt-get update -y
+          sudo apt-get upgrade -y
+          sudo apt-get install -y libgl1-mesa-glx libgl1-mesa-dev libglu1-mesa-dev freeglut3-dev libosmesa6 libosmesa6-dev libgles2-mesa-dev libarchive-dev libpangocairo-1.0-0
+          mamba activate
+          mamba install -y -c cadquery -c conda-forge moab gmsh python-gmsh cadquery=master
+          python -m pip install --upgrade pip 
+          python -m pip install .
+          python -c "import cad_to_dagmc"
+          mamba install -y -c conda-forge "openmc=0.13.3=dagmc*nompi*"
+          python -m pip install .[tests]
+          pytest tests -v
+          cd examples
+          python create_stp_files_for_examples.py
+          python cadquery_assembly.py
+          python cadquery_compound.py
+          python cadquery_object_and_stp_file.py
+          python cadquery_text.py
+          python curved_cadquery_object.py
+          python multiple_cadquery_objects.py
+          python multiple_stp_files.py
+          python single_stp_file_multiple_volumes.py
+          python single_cadquery_object.py
+          python single_stp_file.py

{cad_to_dagmc-0.5.0 → cad_to_dagmc-0.5.1}/.gitignore

@@ -136,3 +136,4 @@ dmypy.json
 *.vtk
 *.stp
 src/_version.py
+*.msh

{cad_to_dagmc-0.5.0 → cad_to_dagmc-0.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cad_to_dagmc
-Version: 0.5.0
+Version: 0.5.1
 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
@@ -20,24 +20,25 @@ Requires-Dist: pytest; extra == "tests"
 
 [![N|Python](https://www.python.org/static/community_logos/python-powered-w-100x40.png)](https://www.python.org)
 
-[![CI with install](https://github.com/fusion-energy/cad_to_dagmc/actions/workflows/ci_with_install.yml/badge.svg)](https://github.com/fusion-energy/cad_to_dagmc/actions/workflows/ci_with_install.yml)
+[![CI with model benchmark zoo](https://github.com/fusion-energy/cad_to_dagmc/actions/workflows/ci_with_benchmarks.yml/badge.svg)](https://github.com/fusion-energy/cad_to_dagmc/actions/workflows/ci_with_benchmarks.yml) Testing package and running examples
+
+[![CI with model benchmark zoo](https://github.com/fusion-energy/cad_to_dagmc/actions/workflows/ci_with_benchmarks.yml/badge.svg?branch=main)](https://github.com/fusion-energy/cad_to_dagmc/actions/workflows/ci_with_benchmarks.yml) Testing with [Model Benchmark Zoo](https://github.com/fusion-energy/model_benchmark_zoo)
 
 [![Upload Python Package](https://github.com/fusion-energy/cad_to_dagmc/actions/workflows/python-publish.yml/badge.svg)](https://github.com/fusion-energy/cad_to_dagmc/actions/workflows/python-publish.yml)
 
 [![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 uses CadQuery functionality to convert CAD geometry to [DAGMC](https://github.com/svalinn/DAGMC/) h5m files
 
-This particular method of producing DAGMC compatible h5m files from CAD geometry
-is intended to convert STP files or [CadQuery](https://cadquery.readthedocs.io) objects to h5m file.
-
-One unique feature of this package is the ability to combine STP files with CadQuery objects.
-This allows for the addition of parametric geometry to static geometry.
+This particular method of producing DAGMC compatible h5m files from CAD geometry is intended to convert STP files or [CadQuery](https://cadquery.readthedocs.io) objects to a DAGMC compatible h5m 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/).
 
+This package is tested with [pytest tests](https://github.com/fusion-energy/cad_to_dagmc/tree/main/tests) and also the DAGMC geometry made with this package is compared to simulation carried out with native constructive solid geometry, see [Model Benchmark Zoo](https://github.com/fusion-energy/model_benchmark_zoo) for more details.
+
+Also checkout these other packages that also create DAGMC geometry [CAD-to-OpenMC](https://github.com/openmsr/CAD_to_OpenMC), [Stellarmesh](https://github.com/Thea-Energy/stellarmesh) 
+
 # Installation prerequisite
 
 In principle, any Conda/Mamba distribution will work. A few Conda/Mamba options are:

{cad_to_dagmc-0.5.0 → cad_to_dagmc-0.5.1}/README.md

@@ -1,24 +1,25 @@
 
 [![N|Python](https://www.python.org/static/community_logos/python-powered-w-100x40.png)](https://www.python.org)
 
-[![CI with install](https://github.com/fusion-energy/cad_to_dagmc/actions/workflows/ci_with_install.yml/badge.svg)](https://github.com/fusion-energy/cad_to_dagmc/actions/workflows/ci_with_install.yml)
+[![CI with model benchmark zoo](https://github.com/fusion-energy/cad_to_dagmc/actions/workflows/ci_with_benchmarks.yml/badge.svg)](https://github.com/fusion-energy/cad_to_dagmc/actions/workflows/ci_with_benchmarks.yml) Testing package and running examples
+
+[![CI with model benchmark zoo](https://github.com/fusion-energy/cad_to_dagmc/actions/workflows/ci_with_benchmarks.yml/badge.svg?branch=main)](https://github.com/fusion-energy/cad_to_dagmc/actions/workflows/ci_with_benchmarks.yml) Testing with [Model Benchmark Zoo](https://github.com/fusion-energy/model_benchmark_zoo)
 
 [![Upload Python Package](https://github.com/fusion-energy/cad_to_dagmc/actions/workflows/python-publish.yml/badge.svg)](https://github.com/fusion-energy/cad_to_dagmc/actions/workflows/python-publish.yml)
 
 [![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 uses CadQuery functionality to convert CAD geometry to [DAGMC](https://github.com/svalinn/DAGMC/) h5m files
 
-This particular method of producing DAGMC compatible h5m files from CAD geometry
-is intended to convert STP files or [CadQuery](https://cadquery.readthedocs.io) objects to h5m file.
-
-One unique feature of this package is the ability to combine STP files with CadQuery objects.
-This allows for the addition of parametric geometry to static geometry.
+This particular method of producing DAGMC compatible h5m files from CAD geometry is intended to convert STP files or [CadQuery](https://cadquery.readthedocs.io) objects to a DAGMC compatible h5m 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/).
 
+This package is tested with [pytest tests](https://github.com/fusion-energy/cad_to_dagmc/tree/main/tests) and also the DAGMC geometry made with this package is compared to simulation carried out with native constructive solid geometry, see [Model Benchmark Zoo](https://github.com/fusion-energy/model_benchmark_zoo) for more details.
+
+Also checkout these other packages that also create DAGMC geometry [CAD-to-OpenMC](https://github.com/openmsr/CAD_to_OpenMC), [Stellarmesh](https://github.com/Thea-Energy/stellarmesh) 
+
 # Installation prerequisite
 
 In principle, any Conda/Mamba distribution will work. A few Conda/Mamba options are:

{cad_to_dagmc-0.5.0 → cad_to_dagmc-0.5.1}/examples/cadquery_compound.py

@@ -17,12 +17,7 @@ r = s.lineTo(3.0, 0).lineTo(3.0, 1.0).spline(spline_points, includeCurrent=True)
 cq_shape_1 = r.extrude(-1)
 
 s2 = cq.Workplane("XY")
-r2 = (
-    s2.lineTo(3.0, 0)
-    .lineTo(3.0, 1.0)
-    .spline(spline_points, includeCurrent=True)
-    .close()
-)
+r2 = s2.lineTo(3.0, 0).lineTo(3.0, 1.0).spline(spline_points, includeCurrent=True).close()
 cq_shape_2 = r2.extrude(1)
 
 

{cad_to_dagmc-0.5.0 → cad_to_dagmc-0.5.1}/examples/cadquery_object_and_stp_file.py

@@ -5,7 +5,5 @@ result = cq.Workplane("XY").moveTo(10, 0).box(3, 3, 0.5).edges("|Z").fillet(0.12
 
 my_model = CadToDagmc()
 my_model.add_cadquery_object(object=result, material_tags=["mat1"])
-my_model.add_stp_file(
-    filename="single_cube.stp", material_tags=["mat2"], scale_factor=0.1
-)
+my_model.add_stp_file(filename="single_cube.stp", material_tags=["mat2"], scale_factor=0.1)
 my_model.export_dagmc_h5m_file(max_mesh_size=0.2, min_mesh_size=0.1)

{cad_to_dagmc-0.5.0 → cad_to_dagmc-0.5.1}/examples/cadquery_text.py

@@ -16,6 +16,4 @@ my_model.add_cadquery_object(
     ],  # 5 volumes one for each letter
 )
 
-my_model.export_dagmc_h5m_file(
-    filename="cadquery_text.h5m", max_mesh_size=0.2, min_mesh_size=0.1
-)
+my_model.export_dagmc_h5m_file(filename="cadquery_text.h5m", max_mesh_size=0.2, min_mesh_size=0.1)

{cad_to_dagmc-0.5.0 → cad_to_dagmc-0.5.1}/examples/create_stp_files_for_examples.py

@@ -46,12 +46,7 @@ spline_points = [
     (0.5, 1.0),
     (0, 1.0),
 ]
-r = (
-    result.lineTo(3.0, 0)
-    .lineTo(3.0, 1.0)
-    .spline(spline_points, includeCurrent=True)
-    .close()
-)
+r = result.lineTo(3.0, 0).lineTo(3.0, 1.0).spline(spline_points, includeCurrent=True).close()
 result = r.extrude(1.5)
 assembly = Assembly()
 assembly.add(result)

{cad_to_dagmc-0.5.0 → cad_to_dagmc-0.5.1}/examples/single_stp_file_multiple_volumes.py

@@ -2,7 +2,5 @@ from cad_to_dagmc import CadToDagmc
 
 my_model = CadToDagmc()
 # the d and c from the word dagmc would be tagged with one material and the agm are tagged with another material
-my_model.add_stp_file(
-    "text_dagmc.stp", material_tags=["mat1", "mat2", "mat2", "mat2", "mat1"]
-)
+my_model.add_stp_file("text_dagmc.stp", material_tags=["mat1", "mat2", "mat2", "mat2", "mat1"])
 my_model.export_dagmc_h5m_file()

cad_to_dagmc-0.5.1/src/_version.py

@@ -0,0 +1,16 @@
+# file generated by setuptools_scm
+# don't change, don't track in version control
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple, Union
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+else:
+    VERSION_TUPLE = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+
+__version__ = version = '0.5.1'
+__version_tuple__ = version_tuple = (0, 5, 1)

{cad_to_dagmc-0.5.0 → cad_to_dagmc-0.5.1}/src/cad_to_dagmc/__init__.py

@@ -13,9 +13,4 @@ except PackageNotFoundError:
 
 __all__ = ["__version__"]
 
-from .core import CadToDagmc
-from .vertices_to_h5m import vertices_to_h5m
-from .brep_part_finder import *
-from .brep_to_h5m import *
-
-[CadToDagmc, vertices_to_h5m]
+from .core import *