Skip to content

Add instructions for args-file #191

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: args-from-file
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,5 +80,20 @@ See [this blog post](https://ross-org.github.io/setup/running-sim.html) for deta
./your-model --synch=1 // sequential mode
mpirun -np 2 ./your-model --synch=2 // conservative mode
mpirun -np 2 ./your-model --synch=3 // optimistic mode
```
You can pass arguments to your model from the command line as shown below.
```
./your-model --synch=4 // optimistic debug mode (note: not a parallel execution!)
```
However, for better readability, it is also possible to pass command line arguments through a text file.
A sample text file sample.txt is included below.
```
# Synchonization protocol
--synch=4
# AVL Tree contains 2^avl-size nodes (default 18)
--avl-size=18
```
The text file is then parsed by ROSS through the args-file command line argument.
```
./your-model --args-file=sample.txt
```