| Name | cad-to-dagmc JSON |
| Version |
0.7.4
JSON |
| download |
| home_page | None |
| Summary | Converts CAD files to a DAGMC h5m file |
| upload_time | 2024-11-27 15:07:31 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
dagmc
geometry
plot
slice
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://www.python.org)
[](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
[](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
[](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)
[](https://github.com/fusion-energy/cad_to_dagmc/actions/workflows/python-publish.yml)
[](https://pypi.org/project/cad_to_dagmc/)
A minimal package that converts CAD geometry to [DAGMC](https://github.com/svalinn/DAGMC/) h5m files
cad-to-dagmc can create:
- surface meshes / faceted geometry / triangular meshes
- unstructured mesh / tetrahedral meshes / volume meshes
cad-to-dagmc can convert:
- STEP files
- CadQuery objects (in memory)
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.
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 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/)
# Installation options
- Install using Mamba
- Install using Conda
- Install using pip and source compilations
## 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 clone the latest version of MOAB and cd into the moab directory.
```
git clone master https://bitbucket.org/fathomteam/moab/
cd moab
```
Ensure pip is up to date as a new version is needed
```
python -m pip install --upgrade pip
```
Run the pip install command with cmake arguments.
```
pip install . --config-settings=cmake.args=-DENABLE_HDF5=ON
```
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.14.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.
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 - creation of DAGMC h5m files
For examples see the [examples folder](https://github.com/fusion-energy/cad_to_dagmc/tree/main/examples)
# Usage - simulation with transport code
For examples 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)
Raw data
{
"_id": null,
"home_page": null,
"name": "cad-to-dagmc",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "dagmc, geometry, plot, slice",
"author": null,
"author_email": "Jonathan Shimwell <mail@jshimwell.com>",
"download_url": "https://files.pythonhosted.org/packages/49/c8/e9fdf5a9703e802a10ba9a4727f39af659cd5350fc4b43c2f9d87552259f/cad_to_dagmc-0.7.4.tar.gz",
"platform": null,
"description": "\n[](https://www.python.org)\n\n[](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\n\n[](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\n\n[](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)\n\n[](https://github.com/fusion-energy/cad_to_dagmc/actions/workflows/python-publish.yml)\n\n[](https://pypi.org/project/cad_to_dagmc/)\n\n\nA minimal package that converts CAD geometry to [DAGMC](https://github.com/svalinn/DAGMC/) h5m files\n\ncad-to-dagmc can create:\n- surface meshes / faceted geometry / triangular meshes\n- unstructured mesh / tetrahedral meshes / volume meshes\n\ncad-to-dagmc can convert:\n- STEP files\n- CadQuery objects (in memory)\n\ncad-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.\n\nThe 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/).\n\nThis 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.\n\nAlso 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/)\n\n# Installation options\n\n- Install using Mamba\n- Install using Conda\n- Install using pip and source compilations\n\n## Install using Mamba\n\nIn principle, installing any Conda/Mamba distribution will work. A few Conda/Mamba options are:\n- [Miniforge](https://github.com/conda-forge/miniforge) (recommended as it includes mamba)\n- [Anaconda](https://www.anaconda.com/download)\n- [Miniconda](https://docs.conda.io/en/latest/miniconda.html)\n\nThis example assumes you have installed the Miniforge option or separately have installed Mamba with ```conda install -c conda-forge mamba -y```\n\nCreate a new environment, I've chosen Python 3.10 here but newer versions are\nalso supported.\n```bash\nmamba create --name new_env python=3.10 -y\n```\n\nActivate the environment\n```bash\nmamba activate new_env\n```\n\nThen you can install the cad_to_dagmc package\n```bash\nmamba install -y -c conda-forge cad_to_dagmc\n```\n\n## Install using Conda\n\nIn principle, installing any Conda/Mamba distribution will work. A few Conda/Mamba options are:\n- [Miniforge](https://github.com/conda-forge/miniforge) (recommended as it includes mamba)\n- [Anaconda](https://www.anaconda.com/download)\n- [Miniconda](https://docs.conda.io/en/latest/miniconda.html)\n\nCreate a new environment, I've chosen Python 3.10 here but newer versions are\nalso supported.\n```bash\nconda create --name new_env python=3.10 -y\n```\n\nActivate the environment\n```bash\nconda activate new_env\n```\n\nThen you can install the cad_to_dagmc package\n```bash\nconda install -y -c conda-forge cad_to_dagmc\n```\n\n## Install using pip and source compilations\n\nIt is also possible to avoid the use of conda/mamba and installing using pip.\n\nFirst ensure hdf5 is installed as this is needed by MOAB pip install command\n\n```\nsudo apt-get install libhdf5-dev\n```\n\nThen clone the latest version of MOAB and cd into the moab directory.\n\n```\ngit clone master https://bitbucket.org/fathomteam/moab/\ncd moab\n```\n\nEnsure pip is up to date as a new version is needed\n```\npython -m pip install --upgrade pip\n```\n\nRun the pip install command with cmake arguments.\n```\npip install . --config-settings=cmake.args=-DENABLE_HDF5=ON\n```\n\nThen you can install the cad_to_dagmc package with ```pip```\n\n```bash\npip install cad_to_dagmc\n```\n\n## Install with OpenMC or other particle transport codes\n\nYou 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/).\n\nTo 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\n```bash\nmamba install -c conda-forge -y \"openmc=0.14.0=dagmc*nompi*\"\n```\n\nIt 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.\n\nAnother 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.\n\n\n# Known incompatibilities\n\nThe package requires newer versions of Linux. For example the package does not work on Ubuntu 18.04 or older.\n\nThe 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```\n\nInstalling 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.\n\n\n# Usage - creation of DAGMC h5m files\n\nFor examples see the [examples folder](https://github.com/fusion-energy/cad_to_dagmc/tree/main/examples)\n\n# Usage - simulation with transport code\n\nFor examples see the [examples folder](https://github.com/fusion-energy/cad_to_dagmc/tree/main/examples)\n\nFor 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)\n",
"bugtrack_url": null,
"license": null,
"summary": "Converts CAD files to a DAGMC h5m file",
"version": "0.7.4",
"project_urls": {
"Bug Tracker": "https://github.com/fusion-energy/cad_to_dagmc/issues",
"Homepage": "https://github.com/fusion-energy/cad_to_dagmc"
},
"split_keywords": [
"dagmc",
" geometry",
" plot",
" slice"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a72a280cfd2972d3ee65f9226985a2e116c2408732be7b6f2ef2845b2d48b2a3",
"md5": "0d417e6687bac3a1237fa6376c1ee00b",
"sha256": "1d2e7f7243241de065922351384fbe17c5e6980c5196cc6e719277c11563598c"
},
"downloads": -1,
"filename": "cad_to_dagmc-0.7.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0d417e6687bac3a1237fa6376c1ee00b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 10941,
"upload_time": "2024-11-27T15:07:29",
"upload_time_iso_8601": "2024-11-27T15:07:29.044412Z",
"url": "https://files.pythonhosted.org/packages/a7/2a/280cfd2972d3ee65f9226985a2e116c2408732be7b6f2ef2845b2d48b2a3/cad_to_dagmc-0.7.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "49c8e9fdf5a9703e802a10ba9a4727f39af659cd5350fc4b43c2f9d87552259f",
"md5": "aa36ea29922244effff13f2a10efb31b",
"sha256": "4a48635ba5b81d20b6ea306d8bf464c38e138fda8ef09e32fcf6d21bdb4a2c2c"
},
"downloads": -1,
"filename": "cad_to_dagmc-0.7.4.tar.gz",
"has_sig": false,
"md5_digest": "aa36ea29922244effff13f2a10efb31b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 1007761,
"upload_time": "2024-11-27T15:07:31",
"upload_time_iso_8601": "2024-11-27T15:07:31.625494Z",
"url": "https://files.pythonhosted.org/packages/49/c8/e9fdf5a9703e802a10ba9a4727f39af659cd5350fc4b43c2f9d87552259f/cad_to_dagmc-0.7.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-27 15:07:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fusion-energy",
"github_project": "cad_to_dagmc",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "cad-to-dagmc"
}
