Skip to content

Commit

Permalink
Release v3.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
PhilipFackler committed Feb 3, 2025
1 parent 6ba432f commit 50a8979
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 9 deletions.
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ set(CMAKE_CXX_STANDARD_REQUIRED ON)
set(CMAKE_CXX_EXTENSIONS OFF)

project(Xolotl
VERSION 3.0.1
VERSION 3.1.0
LANGUAGES CXX
)
if(NOT Xolotl_VERSION_EXACT)
Expand Down
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,33 +10,37 @@ generation tokamaks like ITER, as well as nuclear fuel in fission reactors.
- CMake >= 3.13
- MPI
- Boost
- Kokkos >= 3.2
- Kokkos >= 4.4
- HDF5
- PETSc >= 3.16 (configured with kokkos and kokkos-kernels; see
scripts/build_petsc.sh)

## Quick-Start Install
PETSc can now install Kokkos, Boost, and HDF5
(see [PETSc build script](https://github.com/ORNL-Fusion/xolotl/wiki/Build-Configuration#petsc-build-script)):
Xolotl can now build all dependencies (using PETSc's build system) during the
CMake configure step:
```
cd $HOME
git clone https://gitlab.com/petsc/petsc.git
git clone https://github.com/ORNL-Fusion/xolotl $HOME/xolotl-source
cd xolotl-source/scripts
chmod u+x build_petsc.sh
./build_petsc.sh --prefix=$HOME/petsc-install --petsc-dir=$HOME/petsc --get-boost --get-hdf5
mkdir $HOME/xolotl-build
cd $HOME/xolotl-build
cmake \
-DXolotl_BUILD_PETSC=ON \
[-DXolotl_ENABLE_CUDA=ON | -DXolotl_ENABLE_OPENMP=ON] \
-DCMAKE_BUILD_TYPE=Release \
-DCMAKE_PREFIX_PATH=$HOME/petsc-install \
-DCMAKE_INSTALL_PREFIX=$HOME/xolotl-build/install \
$HOME/xolotl-source/
make
make test
make install
```

If Boost, HDF5, or LAPACK are not found during configuration, they will
automatically be requested from PETSc's build system. Or you can specify this
directly via `-DXolotl_BUILD_BOOST=ON`, *etc.*

If you wish to configure and install PETSc separately, use (or reference) our
[PETSc build script](https://github.com/ORNL-Fusion/xolotl/wiki/Build-Configuration#petsc-build-script).

## Wiki
You can find more information about this code on our
[Wiki](https://github.com/ORNL-Fusion/xolotl/wiki) and how to install Xolotl and
Expand Down

0 comments on commit 50a8979

Please sign in to comment.