Skip to content

Commit 9dcf70a

Browse files
committed
Update Docker development container environment information to be consistent for v2.2.
1 parent 3084695 commit 9dcf70a

File tree

2 files changed

+19
-8
lines changed

2 files changed

+19
-8
lines changed

docker/pylith-devenv

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -110,10 +110,11 @@ USER ${PYLITH_USER}
110110

111111
# Environment variables used in VSCode settings
112112
ENV PYLITH_DIR=${INSTALL_DIR} \
113-
PYLITH_BUILDDIR=${TOPBUILD_DIR}/pylith \
114-
PYTHON_INCDIR=/usr/include/python3.8 \
113+
PYLITH_BUILDDIR=${TOPBUILD_DIR}/pylith \
114+
PETSC_DIR=${PYLITHDEPS_DIR} \
115+
PYTHON_INCDIR=${PYLITHDEPS_DIR}/include/python2.7 \
115116
MPI_INCDIR=/usr/include/x86_64-linux-gnu/mpich \
116-
PROJ_INCDIR=/usr/include \
117+
PROJ_INCDIR=${PYLITHDEPS_DIR}/include \
117118
CPPUNIT_INCDIR=/usr/include
118119

119120
ENV PATH=${PYLITH_DIR}/bin:${PYLITHDEPS_DIR}/bin:${PATH_ORIG} \

docs/devenv/docker-devenv.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ The Docker image also defines the environment:
1818
| :------------------- | :-----------------------------------: | :------------------------------------------------------ |
1919
| `PYTHON_VERSION` | `2.7` | Python version |
2020
| `PYLITH_USER` | `pylith-dev` | Username within container |
21-
| `BASE_DIR` | `/opt/pylith` | Top-level directory for development workspace |
21+
| `DEV_DIR` | `/opt/pylith` | Top-level directory for development workspace |
2222
| `HOME` | `/home/${PYLITH_USER}` | Home directory for user |
23-
| `INSTALL_DIR` | `${BASE_DIR}/dest/debug` | Directory where code is installed |
24-
| `TOPSRC_DIR` | `${BASE_DIR}/src` | Top-level directory for source code |
25-
| `TOPBUILD_DIR` | `${BASE_DIR}/build/debug` | Top-level directory for building |
23+
| `INSTALL_DIR` | `${DEV_DIR}/dest/debug` | Directory where code is installed |
24+
| `TOPSRC_DIR` | `${DEV_DIR}/src` | Top-level directory for source code |
25+
| `TOPBUILD_DIR` | `${DEV_DIR}/build/debug` | Top-level directory for building |
2626
| `PYLITH_BUILDDIR` | `${TOPBUILD_DIR}/pylith` | Top-level directory where we build PyLith [^vscode] |
2727
| `PYLITH_DIR` | `${INSTALL_DIR}` | Directory containing installed PyLith [^vscode] |
2828
| `PYLITHDEPS_DIR` | `/opt/dependencies` | Directory containing external dependencies [^vscode] |
@@ -44,7 +44,7 @@ You only need to run these setup steps once.
4444
2. You need to have a [GitHub](https://github.com) account.
4545
:::
4646

47-
### Fork repositories on GitHub
47+
### Fork repository on GitHub
4848

4949
1. Log in to your [GitHub](https://github.com) account.
5050

@@ -168,6 +168,16 @@ The consequence of using a relative link is that your local clone will look for
168168

169169
### Configure and build PyLith for development
170170

171+
:::{important}
172+
Make sure your PyLith clone is on a v2.2 compatible branch.
173+
This is either `releases/v2.2` from the `geodynamics/pylith` repository or one of your own branches from that branch.
174+
175+
```{code-block} bash
176+
cd /opt/pylith/src
177+
git checkout releases/v2.2
178+
```
179+
:::
180+
171181
```{code-block} bash
172182
cd ${TOPBUILD_DIR}/pylith
173183
pushd ${TOPSRC_DIR} && autoreconf -if && popd

0 commit comments

Comments
 (0)