Skip to content

Commit

Permalink
updates to readme instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
j-bryan committed Oct 11, 2024
1 parent 14b9f20 commit 6ef0998
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 5 deletions.
14 changes: 10 additions & 4 deletions package/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,10 @@ Windows and macOS are the only operating systems currently supported.
Linux users are encouraged to use pip-installed or source built versions of the RAVEN, HERON, and TEAL software packages.

## 1. Build FORCE executables
Create a conda environment `force_build_310`, install the RAVEN, HERON, and TEAL pip packages, and build the FORCE executables using the script
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`.
The path to the conda executable must be provided using the `--conda-defs` argument.
```console
./build_force.sh
./build_force.sh --conda-defs <path to conda directory>/etc/profile.d/conda.sh
```

## 2. Add IPOPT to build directory (Windows only)
Expand All @@ -34,17 +35,22 @@ cp -R examples force_install/examples
cp -R docs force_install/docs
```
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.
If using the `--no-build` option, there is no need to have the `raven_libraries` active.
```console
./make_docs.sh --no-build --raven-dir /path/to/raven --heron-dir /path/to/HERON --teal-dir /path/to/TEAL
cp -R docs force_install/docs
```

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

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

Windows:
```console
cp ~/Downloads/Workbench-5.4.1.exe .
cp ~/Downloads/Workbench-5.4.1.exe force_install
```

macOS:
Expand Down
2 changes: 1 addition & 1 deletion package/build_force.sh
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ while [[ $# -gt 0 ]]; do
CONDA_DEFS="$2"
shift
shift
source $CONDA_DEFS
;;
*)
echo "Unknown option: $1"
Expand All @@ -19,7 +20,6 @@ done

# Establish conda environment
conda create -n force_build_310 python=3.10 -y
source $CONDA_DEFS
conda activate force_build_310

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

0 comments on commit 6ef0998

Please sign in to comment.