Skip to content

Commit

Permalink
Merge pull request #13 from streeve/readme_spack
Browse files Browse the repository at this point in the history
readme: add spack details
  • Loading branch information
colemanjs committed Oct 13, 2023
2 parents a4b9579 + d8c5699 commit f11faf3
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ If you use AdditiveFoam in your work, please cite the [source code](CITATION.bib
- [Gerry L. Knapp](https://www.ornl.gov/staff-profile/gerald-l-knapp)
- [Benjamin Stump](https://www.ornl.gov/staff-profile/benjamin-c-stump)
- [Alex Plotkowski](https://www.ornl.gov/staff-profile/alex-j-plotkowski)
- [Sam T. Reeve](https://www.ornl.gov/staff-profile/samuel-t-reeve)

## Publications
Some select publications using AdditiveFOAM are provided:
Expand All @@ -25,17 +26,21 @@ Some select publications using AdditiveFOAM are provided:
| [tutorials](tutorials) | Tutorial cases based on [NIST AMB2018](https://www.nist.gov/ambench/amb2018-02-description) single tracks |

## Build and Install
AdditiveFOAM is built on source code released by the OpenFOAM Foundation [openfoam.org](https://openfoam.org/), which is available in public [OpenFOAM repositories](https://github.com/OpenFOAM). The current supported version is **OpenFOAM-10**, which can be compiled from source code following the steps provided by the [OpenFOAM Foundation Documentation](https://openfoam.org/download/source/).
AdditiveFOAM is built on source code released by the OpenFOAM Foundation [openfoam.org](https://openfoam.org/), which is available in public [OpenFOAM repositories](https://github.com/OpenFOAM). The current supported version is **OpenFOAM-10**.

Alternatively, OpenFOAM-10 can be installed using spack:
```spack install openfoam-org@10```
### Spack install
[spack](https://spack.readthedocs.io/en/latest/) provides a simple way to install AdditiveFOAM. spack `develop` is currently required:
```spack install additivefoam```

or used within a Docker container:
### Manual install
Alternatively, a Docker container with pre-built OpenFOAM-10 can be used:
```
docker pull openfoam/openfoam10-paraview510
docker run -it openfoam/openfoam10-paraview510
```

or instead OpenFOAM-10 can be compiled from source code following the steps provided by the [OpenFOAM Foundation Documentation](https://openfoam.org/download/source/).

Once **OpenFOAM-10** is available on your system, perform the following steps:

1. Clone the AdditiveFOAM repository into the OpenFOAM project installation directory `WM_PROJECT_USER_DIR`:
Expand All @@ -57,6 +62,7 @@ Once **OpenFOAM-10** is available on your system, perform the following steps:
cd $WM_PROJECT_USER_DIR/AdditiveFOAM/applications/solvers/additiveFoam
wmake
```

## Run AdditiveFOAM
To run an AdditiveFOAM simulation, it is recommended to perform the following steps:
1. Prepare the case directory structure using a provided template:
Expand Down

0 comments on commit f11faf3

Please sign in to comment.