Skip to content

Commit 6789e9d

Browse files
authored
Clarify install docs (#4121)
* Add section about linux ARM VTK * Removes some references to firedrake-install * Makes pip cache remove petsc4py a main instruction so it isn't missed * Moves complex bits about customisation to the bottom of the install instructions * Included explicit information about installing SLEPc and other optional dependencies
1 parent f326724 commit 6789e9d

File tree

6 files changed

+291
-135
lines changed

6 files changed

+291
-135
lines changed

.github/workflows/build.yml

+5-2
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,11 @@ jobs:
7272
xargs -L1 ./configure --with-make-np=8 --download-slepc
7373
make PETSC_DIR=/__w/firedrake/firedrake/petsc PETSC_ARCH=arch-firedrake-${{ matrix.arch }}
7474
make check
75-
echo "PETSC_DIR=/__w/firedrake/firedrake/petsc" >> "$GITHUB_ENV"
76-
echo "PETSC_ARCH=arch-firedrake-${{ matrix.arch }}" >> "$GITHUB_ENV"
75+
{
76+
echo "PETSC_DIR=/__w/firedrake/firedrake/petsc"
77+
echo "PETSC_ARCH=arch-firedrake-${{ matrix.arch }}"
78+
echo "SLEPC_DIR=/__w/firedrake/firedrake/petsc/arch-firedrake-${{ matrix.arch }}"
79+
} >> "$GITHUB_ENV"
7780
7881
- name: Install Firedrake
7982
id: install

demos/eigenvalues_QG_basinmodes/qgbasinmodes.py.rst

+2-4
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,8 @@ dissipative forces. Unlike the other demo that integrated the equations forward
1818
in time, in this problem it is necessary to compute the eigenvalues and
1919
eigenfunctions for a particular differential operator.
2020

21-
This demo requires SLEPc and slepc4py to be installed. This is most easily
22-
achieved by providing the optional `--slepc` flag to either `firedrake-install`
23-
(for a new installation), or `firedrake-update` (to add SLEPc to an existing
24-
installation).
21+
This demo requires SLEPc and slepc4py to be installed. For instructions on how
22+
to install them please follow `these instructions <https://www.firedrakeproject.org/install#slepc>`_.
2523

2624

2725
Governing PDE

demos/netgen/netgen_mesh.py.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Finally we will show how to use mesh refinement features included in Netgen to c
1111

1212
Installing Netgen
1313
------------------
14-
This demo requires the NGSolve/Netgen suite to be installed. This is most easily achieved by providing the optional `--netgen` flag to either `firedrake-install` (for a new installation), or `firedrake-update` (to add the NGSolve/Netgen suite to an existing installation). ::
14+
This demo requires the NGSolve/Netgen suite to be installed. This can be done by running ``pip install ngsPETSc``. ::
1515

1616
from firedrake import *
1717
try:

docs/source/checkpointing.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -617,9 +617,9 @@ Firedrake uses the PETSc_ HDF5 Viewer_ object to write and read state.
617617
As such, writing data is collective across processes. h5py_ is used
618618
for attribute manipulation. To this end, h5py_ *must* be linked
619619
against the same version of the HDF5 library that PETSc was built
620-
with. The ``firedrake-install`` script automates this, however, if
621-
you build PETSc manually, you will need to ensure that h5py_ is linked
622-
correctly following the instructions for custom installation here_.
620+
with. If you have a custom installation of Firedrake then it may be
621+
necessary to manually ensure that h5py is linked correctly.
622+
Instructions for how to do this can be found here_.
623623

624624
.. warning::
625625

0 commit comments

Comments
 (0)