Skip to content

Commit

Permalink
Update docs, changelog, readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sebastiangrimberg committed Aug 7, 2023
1 parent 532055e commit 41c235b
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 2 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ The format of this changelog is based on
## In progress

- Added Apptainer/Singularity container build definition for Palace.
- Added build dependencies on [libCEED](https://github.com/CEED/libCEED) and
[LIBXSMM](https://github.com/libxsmm/libxsmm) to support operator partial assembly (CPU-
based for now).

## [0.11.2] - 2023-07-14

Expand Down
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,11 @@ the frequency or time domain, using the
command `spack install palace`. Run `spack info palace` to get more information about the
available configuration options and dependencies.

Instructions for obtaining *Palace* and building from source can be found in the
Those wishing to work in a containerized environment may use the Singularity/Apptainer
container for *Palace* which is built from the recipe in [`singularity/`](./singularity) and
pushed to the GitHub Container Registry at https://ghcr.io/awslabs/palace.

Finally, instructions for obtaining *Palace* and building from source can be found in the
[documentation](https://awslabs.github.io/palace/dev/install/). As part of the CMake build
process, most dependencies are downloaded and installed automatically and thus an internet
connection is required.
Expand Down
8 changes: 7 additions & 1 deletion docs/src/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,12 +113,15 @@ Additional build options are (with default values in brackets):

- `PALACE_WITH_64BIT_INT [OFF]` : Build with 64-bit integer support
- `PALACE_WITH_OPENMP [OFF]` : Use OpenMP
- `PALACE_WITH_LIBCEED [ON]` : Build with libCEED library for high-order partial assembly
support
- `PALACE_WITH_GSLIB [ON]` : Build with GSLIB library for high-order field interpolation
- `PALACE_WITH_SUPERLU [ON]` : Build with SuperLU_DIST sparse direct solver
- `PALACE_WITH_STRUMPACK [OFF]` : Build with STRUMPACK sparse direct solver
- `PALACE_WITH_MUMPS [OFF]` : Build with MUMPS sparse direct solver
- `PALACE_WITH_SLEPC [ON]` : Build with SLEPc eigenvalue solver
- `PALACE_WITH_ARPACK [OFF]` : Build with ARPACK eigenvalue solver
- `PALACE_WITH_LIBXSMM [ON]` : Build with LIBXSMM backend when libCEED is enabled

The build step is invoked by running (for example with 4 `make` threads)

Expand Down Expand Up @@ -171,7 +174,8 @@ as the standard parallelization in approach in *Palace* is to use pure MPI paral
*Palace* leverages the [MFEM finite element discretization library](http://mfem.org). It
always configures and builds its own installation of MFEM internally in order to support
the most up to date features and patches. Likewise, Palace will always build its own
installation of [GSLIB](https://github.com/Nek5000/gslib), when `PALACE_WITH_GSLIB=ON`.
installation of [libCEED](https://github.com/CEED/libCEED), when `PALACE_WITH_LIBCEED=ON`,
and [GSLIB](https://github.com/Nek5000/gslib), when `PALACE_WITH_GSLIB=ON`.

As part of the [Build from source](#Build-from-source), the CMake build will automatically
build and install a small number of third-party dependencies before building *Palace*. The
Expand All @@ -192,6 +196,8 @@ source code for these dependencies is downloaded using using [Git submodules]
[PETSc](https://petsc.org/release/)
- [ARPACK-NG](https://github.com/opencollab/arpack-ng) (optional, when
`PALACE_WITH_ARPACK=ON`)
- [LIBXSMM](https://github.com/libxsmm/libxsmm) (optional, when `PALACE_WITH_LIBXSMM=ON`
and `PALACE_WITH_LIBCEED=ON`)
- [nlohmann/json](https://github.com/nlohmann/json)
- [fmt](https://fmt.dev/latest)
- [Eigen](https://eigen.tuxfamily.org)
Expand Down

0 comments on commit 41c235b

Please sign in to comment.