Skip to content

Commit 5faf571

Browse files
committed
adding example usage of HiOpBBpy to README
1 parent ea2bf35 commit 5faf571

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,20 @@ HiOpBBpy can be built via pip. A standard build can be done by invoking the foll
134134
$> pip install .
135135
```
136136
137+
## Usage
138+
139+
Various example scripts are contained in src/Drivers/hiopbbpy/ that can be run directly from said directory, e.g.,
140+
141+
```shell
142+
$> python BODriverEx.py
143+
```
144+
145+
or to run the same script but utilizing MPI parallelism with 4 workers
146+
147+
```shell
148+
$> env MPI4PY_FUTURES_MAX_WORKERS=4 mpiexec -n 1 python BODriverEx.py
149+
```
150+
137151
## Dependencies
138152
139153
HiOpBBpy dependencies are listed in the pyproject.toml file.

0 commit comments

Comments
 (0)