Merge pull request #20 from rfd1/main

Typo and installation instructions

Author: jorgensd

README.md

@@ -26,6 +26,19 @@ Several (non-local) operators are implemented in {py:mod}`fenicsx_ii`:
 
 Any other operator can be implemented by following the {py:class}`ReductionOperator<fenicsx_ii.ReductionOperator>`-protocol.
 
+## Installation
+
+Users are encouraged to install `fenicsx_ii` with `pip` in an environment where `dolfinx` is already installed.
+
+### `pip`
+To install the package with `pip` run
+
+```bash
+python3 -m pip install fenicsx_ii --no-build-isolation
+```
+
+Note that you should pass the flag `--no-build-isolation` to `pip` to avoid issues with the build environment, such as incompatible versions of `nanobind`.
+
 ## Funding
 
 The development of FEniCSx_ii has been funded by the Wellcome Trust,

demos/coupled_domains.py

@@ -6,7 +6,7 @@
 # The following example shows how to couple two non-overlapping meshes using FEniCSx_ii.
 
 # This example will consider two domains, $\Omega_0=[0,1]\times[0,1]$ and
-# $\Omega_1=[4, 3]\times[5,3]$.
+# $\Omega_1=[4, 3]\times[5,4]$.
 # We will compute the following integral
 #
 # $$
@@ -15,7 +15,7 @@
 # \end{align}
 # $$
 #
-# where $\mathbf{x_1}\in \Omega_1$, and $T(\mathbf{x_1}): \Omega_1\mapsto \Omega_0$
+# where $\mathbf{x_1}\in \Omega_1$, and $T: \Omega_1\mapsto \Omega_0$
 # through a translation.
 #
 # First we start by importing the necessary modules:

demos/coupled_poisson_solver.py

@@ -109,14 +109,14 @@
 # \end{align}
 # $$
 #
-# with the variational formulation
+# where $\xi > 0$ is the permeability constant, with the variational formulation
 #
 # $$
 # \begin{align*}
 #   \int_\Omega \alpha_1 \nabla u \cdot \nabla v~\mathrm{d}x
 #   + \int_\Gamma P\xi (\Pi_R(u) - p)\Pi_R(v)~\mathrm{d}s
 #   &= \int_\Omega f\cdot v~\mathrm{d}x\\
-#   \int_\Gamma d_s p \cdot d_s q~\mathrm{d}s
+#   \int_\Gamma A d_s p \cdot d_s q~\mathrm{d}s
 #   + \int_\Gamma P\xi (p - \Pi_R(u))q~\mathrm{d}s
 #   &= \int_\Gamma A\hat f\cdot q~\mathrm{d}s
 # \end{align*}