Skip to content

Commit fc2d401

Browse files
committed
#60: fix documentation of build/test process
1 parent c747023 commit fc2d401

File tree

5 files changed

+5
-5
lines changed

5 files changed

+5
-5
lines changed

docs/source/build.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Steps
2828
cd $BUILDDIR && make -j4
2929
3030
# ensure you have all required Python packages installed
31-
pip3 install <path-to-your-cloned-repo>/py_requirements.txt
31+
pip3 install -r <path-to-your-cloned-repo>/py_requirements.txt
3232
3333
3434
Verify the build

docs/source/endtoend/swe_galerkin_default.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Step 1: execute FOMs
4646
.. code-block:: bash
4747
4848
# from within $BUILDDIR/end-to-end-roms/2d_swe_galerkin_default
49-
python3 $REPOSRC/wf_foms.py --wf wf.yaml
49+
python3 $REPOSRC/end-to-end-roms/wf_foms.py --wf wf.yaml
5050
5151
This driver script automates this first stage by creating input files,
5252
generating run directories and running the C++ executable

docs/source/endtoend/swe_galerkin_hypred_1.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Step 1: run FOMs
4646

4747
.. code-block:: bash
4848
49-
python3 $REPOSRC/wf_foms.py --wf wf.yaml
49+
python3 $REPOSRC/end-to-end-roms/wf_foms.py --wf wf.yaml
5050
5151
The FOM stage is the same as `here <swe_galerkin_default.html>`_.
5252

docs/source/endtoend/swe_lspg_default.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Step 1: execute FOMs
4747
.. code-block:: bash
4848
4949
# from within $BUILDDIR/end-to-end-roms/2d_swe_lspg_default
50-
python3 $REPOSRC/wf_foms.py --wf wf.yaml
50+
python3 $REPOSRC/end-to-end-roms/wf_foms.py --wf wf.yaml
5151
5252
.. warning::
5353

docs/source/endtoend/swe_lspg_hypred_1.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ The FOM stage is the same as `here <swe_lspg_default.html>`_.
4747
.. code-block:: bash
4848
4949
# from within $BUILDDIR/end-to-end-roms/2d_swe_lspg_hypred_1
50-
python3 $REPOSRC/wf_foms.py --wf wf.yaml
50+
python3 $REPOSRC/end-to-end-roms/wf_foms.py --wf wf.yaml
5151
5252
.. warning::
5353

0 commit comments

Comments
 (0)