Skip to content

Commit 6ef0998

Browse files
committed
updates to readme instructions
1 parent 14b9f20 commit 6ef0998

File tree

2 files changed

+11
-5
lines changed

2 files changed

+11
-5
lines changed

package/README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,10 @@ Windows and macOS are the only operating systems currently supported.
77
Linux users are encouraged to use pip-installed or source built versions of the RAVEN, HERON, and TEAL software packages.
88

99
## 1. Build FORCE executables
10-
Create a conda environment `force_build_310`, install the RAVEN, HERON, and TEAL pip packages, and build the FORCE executables using the script
10+
Create a conda environment `force_build_310`, install the RAVEN, HERON, and TEAL pip packages, and build the FORCE executables using the script `build_force.sh`.
11+
The path to the conda executable must be provided using the `--conda-defs` argument.
1112
```console
12-
./build_force.sh
13+
./build_force.sh --conda-defs <path to conda directory>/etc/profile.d/conda.sh
1314
```
1415

1516
## 2. Add IPOPT to build directory (Windows only)
@@ -34,17 +35,22 @@ cp -R examples force_install/examples
3435
cp -R docs force_install/docs
3536
```
3637
When running the `make_docs.sh` script, the optional `--no-build` flag may be added if the desired documentation PDFs have already been built, and you do not wish to rebuild the documents.
38+
If using the `--no-build` option, there is no need to have the `raven_libraries` active.
39+
```console
40+
./make_docs.sh --no-build --raven-dir /path/to/raven --heron-dir /path/to/HERON --teal-dir /path/to/TEAL
41+
cp -R docs force_install/docs
42+
```
3743

3844
## 4. Get NEAMS Workbench installer
3945
The installers for the NEAMS Workbench software can be found here:
4046
https://code.ornl.gov/neams-workbench/downloads/-/tree/5.4.1?ref_type=heads
4147

4248
Download `Workbench-5.4.1.exe` for Windows and `Workbench-5.4.1.dmg` for macOS.
43-
Place this file in the current directory.
49+
Place this file in the `force_install` directory on Windows or the current directory on macOS.
4450

4551
Windows:
4652
```console
47-
cp ~/Downloads/Workbench-5.4.1.exe .
53+
cp ~/Downloads/Workbench-5.4.1.exe force_install
4854
```
4955

5056
macOS:

package/build_force.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ while [[ $# -gt 0 ]]; do
99
CONDA_DEFS="$2"
1010
shift
1111
shift
12+
source $CONDA_DEFS
1213
;;
1314
*)
1415
echo "Unknown option: $1"
@@ -19,7 +20,6 @@ done
1920

2021
# Establish conda environment
2122
conda create -n force_build_310 python=3.10 -y
22-
source $CONDA_DEFS
2323
conda activate force_build_310
2424

2525
# Check that the conda environment is active. If not, exit.

0 commit comments

Comments
 (0)