Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improved install documentation #66

Merged
merged 2 commits into from
Mar 18, 2024
Merged

improved install documentation #66

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
44b8c05
improved install section
shimwell Mar 17, 2024
cffc008
writting env out
shimwell Mar 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .github/workflows/ci_with_benchmarks.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,5 +47,6 @@ jobs:
git clone --single-branch -b main --depth 1 https://github.com/fusion-energy/model_benchmark_zoo.git
cd model_benchmark_zoo
python -m pip install .[tests]
conda list
conda env export > environment.yml
cat environment.yml
pytest tests/test_cad_to_dagmc -v
20 changes: 14 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,20 +20,24 @@ 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/).

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 prerequisite
# Installation options

- Install using Mamba and minimal pip
- Install using Conda and minimal pip
- Install using pip and source compilations
- Install using Conda and maximum pip TODO
- Install using Mamba and maximum pip TODO


# Install using Mamba and pip
## 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)
Expand Down Expand Up @@ -75,7 +79,7 @@ It might not be possible to install OpenMC and cad-to-dagmc in the same conda/ma
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)
Expand Down Expand Up @@ -104,17 +108,21 @@ Then you can install the cad_to_dagmc package with ```pip```
pip install cad_to_dagmc
```

# Install using pip
## Install using pip and source compilations

It is 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 cadquery and ocp using pip

```bash
pip install cadquery-ocp==7.7.2
pip install cadquery==2.4.0
```

Then you can install the cad_to_dagmc package with ```pip```

```bash
pip install cad_to_dagmc
```
Expand Down