-
Notifications
You must be signed in to change notification settings - Fork 42
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'develop' into documentation/update2
- Loading branch information
Showing
8 changed files
with
520 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
Getting Started | ||
================ | ||
|
||
Installing MaestroWF | ||
********************* | ||
|
||
MaestroWF can be installed via pip:: | ||
|
||
$ pip install maestrowf | ||
|
||
.. note:: Using a `virtualenv <https://virtualenv.pypa.io/en/stable/>`_ is recommended. | ||
|
||
Once installed run:: | ||
|
||
$ maestro -h | ||
usage: maestro [-h] [-l LOGPATH] [-d DEBUG_LVL] [-c] {cancel,run,status} ... | ||
|
||
The Maestro Workflow Conductor for specifiying, launching, and managing general workflows. | ||
|
||
positional arguments: | ||
{cancel,run,status} | ||
cancel Cancel all running jobs. | ||
run Launch a study based on a specification | ||
status Check the status of a running study. | ||
|
||
optional arguments: | ||
-h, --help show this help message and exit | ||
-l LOGPATH, --logpath LOGPATH | ||
Alternate path to store program logging. | ||
-d DEBUG_LVL, --debug_lvl DEBUG_LVL | ||
Level of logging messages to be output: | ||
5 - Critical | ||
4 - Error | ||
3 - Warning | ||
2 - Info (Default) | ||
1 - Debug | ||
-c, --logstdout Log to stdout in addition to a file. [Default: True] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
LULESH Specification Breakdown | ||
=============================== | ||
|
||
Stub |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
Maestro Core Concepts | ||
====================== | ||
|
||
Stub |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.