cad-to-dagmc 0.9.9__py3-none-any.whl → 0.11.0__py3-none-any.whl

cad_to_dagmc-0.9.9.dist-info/METADATA

@@ -1,179 +0,0 @@
-Metadata-Version: 2.4
-Name: cad_to_dagmc
-Version: 0.9.9
-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
-Project-URL: Bug Tracker, https://github.com/fusion-energy/cad_to_dagmc/issues
-Keywords: dagmc,geometry,plot,slice
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: trimesh
-Requires-Dist: networkx
-Requires-Dist: cadquery>=2.5.2
-Requires-Dist: numpy
-Requires-Dist: gmsh
-Provides-Extra: tests
-Requires-Dist: pytest; extra == "tests"
-Requires-Dist: vtk; extra == "tests"
-Requires-Dist: assembly-mesh-plugin; extra == "tests"
-Dynamic: license-file
-
-
-[![N|Python](https://www.python.org/static/community_logos/python-powered-w-100x40.png)](https://www.python.org)
-
-[![CI with Conda install](https://github.com/fusion-energy/cad_to_dagmc/actions/workflows/ci_with_conda_install.yml/badge.svg)](https://github.com/fusion-energy/cad_to_dagmc/actions/workflows/ci_with_conda_install.yml) Testing package and running examples with dependencies installed via Conda
-
-[![CI with pip install](https://github.com/fusion-energy/cad_to_dagmc/actions/workflows/ci_with_pip_install.yml/badge.svg)](https://github.com/fusion-energy/cad_to_dagmc/actions/workflows/ci_with_pip_install.yml) Testing package and running examples with dependencies installed vua PIP
-
-[![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 converts CAD geometry to [DAGMC](https://github.com/svalinn/DAGMC/) (h5m) files, [unstructured mesh](https://docs.openmc.org/en/latest/pythonapi/generated/openmc.UnstructuredMesh.html) files (vtk) and Gmsh (msh) files ready for use in neutronics simulations.
-
-cad-to-dagmc can create DAGMC compatible:
-- surface meshes / faceted geometry / triangular meshes
-- unstructured mesh / tetrahedral meshes / volume meshes
-
-cad-to-dagmc can convert the following in to DAGMC compatible meshes:
-- STEP files
-- CadQuery objects (optionally use names as material tags)
-- Gmsh meshes (optionally use physical groups as material tags)
-
-Cad-to-dagmc offers a wide range of features including.
-- Geometry scaling with ```scale_factor``` argument
-- Direct surface meshing of CadQuery geometry with ```tolerance``` and ```angular_tolerance``` arguments (avoids using Gmsh)
-- Model wide mesh Gmsh size parameters with ```min_mesh_size``` and ```max_mesh_size``` arguments
-- Volume specific mesh sizing parameters with the ```set_size``` argument
-- Unstructured mesh that share the same coordinates as the surface mesh.
-- Volume mesh allows selecting individual volumes in the geometry.
-- Parallel meshing to quickly mesh the geometry using multiple CPU cores
-- Imprint and merging of CAD geometry, or disable with the ```imprint``` argument
-- Add geometry from multiple sources ([STEP](http://www.steptools.com/stds/step/) files, [CadQuery](https://cadquery.readthedocs.io) objects and [Gmsh](https://gmsh.info/) meshes)
-- Ability to tag the DAGMC implicit complement material using the ```implicit_complement_material_tag``` argument
-- Selected different Gmesh mesh algorithms (defaults to 1) using the ```mesh_algorithm``` argument
-- Pass CadQuery objects in memory for fast transfer of geometry using the ```method``` argument
-- Easy to install with [pip](https://pypi.org/project/cad-to-dagmc/) and [Conda/Mamba](https://anaconda.org/conda-forge/cad_to_dagmc)
-- Well tested both with [CI unit tests](https://github.com/fusion-energy/cad_to_dagmc/tree/main/tests), integration tests and the CSG [Model Benchmark Zoo](https://github.com/fusion-energy/model_benchmark_zoo).
-- Access to the Gmsh mesh to allow user to define full set of mesh parameters
-- Option to use Gmsh physical groups as material tags
-- Compatibly with [assembly-mesh-plugin](https://github.com/CadQuery/assembly-mesh-plugin) (see examples)
-- Compatible with [Paramak](https://github.com/fusion-energy/paramak) geometry for fusion simulations.
-
-
-# Installation options
-
-- Install using Mamba
-- Install using Conda
-- Install using pip
-
-## Install using Mamba
-
-In principle, installing any Conda/Mamba distribution will work. A few Conda/Mamba options are:
-- [Miniforge](https://github.com/conda-forge/miniforge) (recommended as it includes mamba)
-- [Anaconda](https://www.anaconda.com/download)
-- [Miniconda](https://docs.conda.io/en/latest/miniconda.html)
-
-This example assumes you have installed the Miniforge option or separately have installed Mamba with ```conda install -c conda-forge mamba -y```
-
-Create a new environment, I've chosen Python 3.10 here but newer versions are
-also supported.
-```bash
-mamba create --name new_env python=3.10 -y
-```
-
-Activate the environment
-```bash
-mamba activate new_env
-```
-
-Then you can install the cad_to_dagmc package
-```bash
-mamba install -y -c conda-forge cad_to_dagmc
-```
-
-## Install using Conda
-
-In principle, installing any Conda/Mamba distribution will work. A few Conda/Mamba options are:
-- [Miniforge](https://github.com/conda-forge/miniforge) (recommended as it includes mamba)
-- [Anaconda](https://www.anaconda.com/download)
-- [Miniconda](https://docs.conda.io/en/latest/miniconda.html)
-
-Create a new environment, I've chosen Python 3.10 here but newer versions are
-also supported.
-```bash
-conda create --name new_env python=3.10 -y
-```
-
-Activate the environment
-```bash
-conda activate new_env
-```
-
-Then you can install the cad_to_dagmc package
-```bash
-conda install -y -c conda-forge cad_to_dagmc
-```
-
-## Install using pip and source compilations
-
-It is also possible to avoid the use of conda/mamba and installing using pip.
-
-First ensure hdf5 is installed as this is needed by MOAB pip install command
-
-```
-sudo apt-get install libhdf5-dev
-```
-
-Then install MOAB, currently available from the repo.
-
-```
-pip install git+https://bitbucket.org/fathomteam/moab/
-```
-
-Then you can install the cad_to_dagmc package with ```pip```
-
-```bash
-pip install cad_to_dagmc
-```
-
-## Install with OpenMC or other particle transport codes
-
-You may also want to install OpenMC with DAGMC to make use of the h5m geometry files produced in simulations. However you could also use other supported particle transport codes such as MCNP, FLUKA and others [link to DAGMC documentation](https://svalinn.github.io/DAGMC/).
-
-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.15.2=dagmc*nompi*"
-```
-
-You could also install using this [wheel repo](https://github.com/shimwell/wheels)
-
-Another option would be to [install OpenMC from source](https://docs.openmc.org/en/stable/quickinstall.html) which would also need compiling with MOAB and DAGMC options.
-
-
-# Known incompatibilities
-
-The package requires newer versions of Linux. For example the package does not work on Ubuntu 18.04 or older.
-
-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
-
-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)
-
-# Related software
-
-Also checkout these other software projects that also create DAGMC geometry [CAD-to-OpenMC](https://github.com/openmsr/CAD_to_OpenMC), [Stellarmesh](https://github.com/Thea-Energy/stellarmesh) and [Coreform Cubit](https://coreform.com/products/coreform-cubit/).

cad_to_dagmc-0.9.9.dist-info/RECORD

@@ -1,9 +0,0 @@
-_version.py,sha256=ICJcCYYRydywQ4LYVoe5Hg1g5gm82yoqqH0yhtrP2aM,704
-cad_to_dagmc/__init__.py,sha256=oCr1P0QnBsf6AH0RZujX7T7tdrb75NazdF70HtqXSfc,528
-cad_to_dagmc/core.py,sha256=i9CfNmDBCGati5YzfSA9ymwcgxeleDDN71ge5laxjr8,44105
-cad_to_dagmc/direct_mesh_plugin.py,sha256=iKPYtWQd35Ipxv6g8fZ-r7GFKd1VlCwrSfaNzrGFtf0,24131
-cad_to_dagmc-0.9.9.dist-info/licenses/LICENSE,sha256=B8kznH_777JVNZ3HOKDc4Tj24F7wJ68ledaNYeL9sCw,1070
-cad_to_dagmc-0.9.9.dist-info/METADATA,sha256=xhzOG-Pb2wBJB5_wHaMhNxRIREnJxVqslrFrFUlaLf0,8994
-cad_to_dagmc-0.9.9.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-cad_to_dagmc-0.9.9.dist-info/top_level.txt,sha256=zTi8C64SEBsE5WOtPovnxhOzt-E6Oc5nC3RW6M_5aEA,22
-cad_to_dagmc-0.9.9.dist-info/RECORD,,