cad-to-dagmc 0.6.0__py3-none-any.whl → 0.6.1__py3-none-any.whl

_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.6.0'
-__version_tuple__ = version_tuple = (0, 6, 0)
+__version__ = version = '0.6.1'
+__version_tuple__ = version_tuple = (0, 6, 1)

{cad_to_dagmc-0.6.0.dist-info → cad_to_dagmc-0.6.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cad_to_dagmc
-Version: 0.6.0
+Version: 0.6.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
@@ -14,6 +14,8 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: trimesh
 Requires-Dist: networkx
+Requires-Dist: cadquery-ocp >=7.7.2
+Requires-Dist: cadquery >=2.4.0
 Provides-Extra: tests
 Requires-Dist: pytest ; extra == 'tests'
 Requires-Dist: vtk ; extra == 'tests'
@@ -40,8 +42,7 @@ cad-to-dagmc can convert:
 - STEP files
 - CadQuery objects (in memory)
 
-cadto-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.
-
+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/).
 
@@ -49,16 +50,20 @@ This package is tested with [pytest tests](https://github.com/fusion-energy/cad_
 
 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 prerequisite
+# Installation options
+
+- Install using Mamba and pip
+- Install using Conda and pip
+- Install using pip and source compilations
+
 
-In principle, any Conda/Mamba distribution will work. A few Conda/Mamba options are:
+## Install using Mamba and pip
+
+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)
 
-
-# Install using Mamba and pip
-
 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 conda environment, I've chosen Python 3.10 here but newer versions are
@@ -74,7 +79,7 @@ mamba activate new_env
 
 Install the dependencies
 ```bash
-mamba install -y -c conda-forge gmsh python-gmsh moab>=5.3.0 ocp>=7.7.2.0 cadquery>=2.4.0
+mamba install -y -c conda-forge "moab>=5.3.0" gmsh python-gmsh
 ```
 
 Then you can install the cad_to_dagmc package with ```pip```
@@ -82,19 +87,13 @@ Then you can install the cad_to_dagmc package with ```pip```
 pip install cad_to_dagmc
 ```
 
-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. 
 
+## Install using Conda and pip
 
-# Install using Conda and pip
+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 uses Conda to install some dependencies that are not available via PyPi.
 
@@ -110,7 +109,7 @@ conda activate new_env
 
 Install the dependencies
 ```bash
-conda install -y -c conda-forge gmsh python-gmsh moab>=5.3.0 ocp>=7.7.2.0 cadquery>=2.4.0
+conda install -y -c conda-forge "moab>=5.3.0" gmsh python-gmsh
 ```
 
 Then you can install the cad_to_dagmc package with ```pip```
@@ -118,6 +117,43 @@ Then you can install the cad_to_dagmc package with ```pip```
 pip install cad_to_dagmc
 ```
 
+## Install using pip and source compilations
+
+It should possible to avoid the use of conda and installing using pip and compiling from source.
+
+First compile MOAB (and install Pymoab) from source
+
+Then install gmsh from source (installing from pip appears to cause conflicts with the open cascade used in ocp and cadquery)
+
+Then you can install the cad_to_dagmc package with ```pip```
+
+```bash
+pip install cad_to_dagmc
+```
+
+## Install with transport code (e.g OpenMC)
+
+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 occational errors when passing cad objects between cadquery / ocp and gmsh. The conda install gmsh appears to work fine.
+
 # Usage - with OpenMC
 
 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 supported by [DAGMC](https://svalinn.github.io/DAGMC/).

cad_to_dagmc-0.6.1.dist-info/RECORD

@@ -0,0 +1,8 @@
+_version.py,sha256=lgiCYGSijhLK71WmuudWf_AyhNAutwQWx2V8bV6a5VQ,411
+cad_to_dagmc/__init__.py,sha256=fskHUTyCunSpnpJUvBfAYjx4uwDKXHTTiMP6GqnFRf0,494
+cad_to_dagmc/core.py,sha256=eMwKgKOjje3gBZEqjNzy9O6NF8a02WxD-VhXB5AJg58,18108
+cad_to_dagmc-0.6.1.dist-info/LICENSE,sha256=B8kznH_777JVNZ3HOKDc4Tj24F7wJ68ledaNYeL9sCw,1070
+cad_to_dagmc-0.6.1.dist-info/METADATA,sha256=Fw_uOmqvNJCm1-XPMr1vy4fWgxWW4ZPmqSgCJouGmr4,8183
+cad_to_dagmc-0.6.1.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+cad_to_dagmc-0.6.1.dist-info/top_level.txt,sha256=zTi8C64SEBsE5WOtPovnxhOzt-E6Oc5nC3RW6M_5aEA,22
+cad_to_dagmc-0.6.1.dist-info/RECORD,,

cad_to_dagmc-0.6.0.dist-info/RECORD

@@ -1,8 +0,0 @@
-_version.py,sha256=2JKwcA-YQ0okV2N-gwTWy_n51igWrPcsKQFm0cnqsvw,411
-cad_to_dagmc/__init__.py,sha256=fskHUTyCunSpnpJUvBfAYjx4uwDKXHTTiMP6GqnFRf0,494
-cad_to_dagmc/core.py,sha256=eMwKgKOjje3gBZEqjNzy9O6NF8a02WxD-VhXB5AJg58,18108
-cad_to_dagmc-0.6.0.dist-info/LICENSE,sha256=B8kznH_777JVNZ3HOKDc4Tj24F7wJ68ledaNYeL9sCw,1070
-cad_to_dagmc-0.6.0.dist-info/METADATA,sha256=Zrz_-X2KkLAoKrucNIcvOr1070dmSxq10ytsfqU5oWA,6771
-cad_to_dagmc-0.6.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-cad_to_dagmc-0.6.0.dist-info/top_level.txt,sha256=zTi8C64SEBsE5WOtPovnxhOzt-E6Oc5nC3RW6M_5aEA,22
-cad_to_dagmc-0.6.0.dist-info/RECORD,,