Skip to content
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

README tweak to update quickstart link. #139

Merged
merged 2 commits into from
Oct 21, 2018
Merged
Changes from 1 commit
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
34 changes: 1 addition & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,39 +68,7 @@ If you plan to develop on MaestroWF, install the repository directly using:

### Quickstart Example

MaestroWF comes packed with a basic example using LULESH, a proxy application provided
by LLNL. Information and source code for LULESH can be found [here](https://codesign.llnl.gov/lulesh.php).

The example performs the following workflow locally:
- Download LULESH from the webpage linked above and decompress it.
- Substitute all necessary variables with their serial compilers and make LULESH.
- Execute a small parameter sweep of varying size and iterations (a simple sensitivity study)

Two copies of the workflow are in the ```samples/lulesh``` directory for unix and macosx.
This is due to differences with ```sed```. In order to execute the sample study simply
execute from the root directory of the repository:

Unix:

$ maestro run ./samples/lulesh/lulesh_sample1_unix.yaml

MacOSX:

$ maestro run ./samples/lulesh/lulesh_sample1_macosx.yaml

When prompted, reply in the affirmative:

$ Would you like to launch the study?[yn] y

Maestro will create a timestamped directory in ```sample_output/lulesh```.

To monitor the study run:

$ maestro status sample_output/lulesh/<study_dir>

To cancel the study:

$ maestro cancel sample_output/lulesh/<study_dir>
MaestroWF comes packed with a basic example using LULESH, a proxy application provided by LLNL. You can find the Quick Start guide [here](https://maestrowf.readthedocs.io/en/latest/quick_start.html#).

----------------

Expand Down