Commit 8c57f090 authored by Valentin Reis's avatar Valentin Reis
Browse files

Readme update.

parent 021f3476
Pipeline #5409 passed with stage
in 2 minutes and 27 seconds
#### `argotk` #### `argotk`
This is a stack executor for argo. It can be used standalone and drives CI tests. stack executor for argo, used for experiments and CI tests. should be
It should be used via [argotest](https://xgitlab.cels.anl.gov/argo/argotest). provisioned via [argonix](https://xgitlab.cels.anl.gov/argo/argonix).
#### Usage #### Usage
...@@ -23,9 +23,8 @@ Output: ...@@ -23,9 +23,8 @@ Output:
argotk TestHello --help argotk TestHello --help
``` ```
### Hacking ### Hacking
- see `default.nix` - `nix-shell` provides cabal-build, ghcid, hlint
- edit `.README.md` in place of README.md and run ./shake.hs as a pre-commit hook. - edit `.README.md` in place of README.md, run ./shake.hs to generate.
#### `argotk` #### `argotk`
This is a stack executor for argo. It can be used standalone and drives stack executor for argo, used for experiments and CI tests. should be
CI tests. It should be used via provisioned via [argonix](https://xgitlab.cels.anl.gov/argo/argonix).
[argotest](https://xgitlab.cels.anl.gov/argo/argotest).
#### Usage #### Usage
...@@ -41,9 +40,11 @@ Available commands: ...@@ -41,9 +40,11 @@ Available commands:
one *power* message to cmd listen. one *power* message to cmd listen.
TestSTREAM Setup stack, run STREAM and check that it sends at TestSTREAM Setup stack, run STREAM and check that it sends at
least one progress message to the daemon. least one progress message to the daemon.
RunAMG Set up and start daemon, run app in a container. RunAMG Run AMG in the argo stack.
RunQMCPack Run QMCPACK in the argo stack.
RunOpenMC Run OpenMC in the argo stack.
RunSTREAM Set up and start daemon, run app in a container. RunSTREAM Set up and start daemon, run app in a container.
RunLAMMPS Set up and start daemon, run app in a container. RunLAMMPS Run LAMMPS in the argo stack.
tests Run hardware-independent CI tests tests Run hardware-independent CI tests
``` ```
...@@ -59,11 +60,13 @@ Output: ...@@ -59,11 +60,13 @@ Output:
Usage: argotk TestHello [-v|--verbose] [--app APP] Usage: argotk TestHello [-v|--verbose] [--app APP]
[--container_name ARGO_CONTAINER_UUID] [--container_name ARGO_CONTAINER_UUID]
[--output_dir DIR] [--manifest_directory DIR] [--output_dir DIR] [--manifest_directory DIR]
[--manifest_name FILENAME] [--daemon BEHAVIOR] [--manifest_name FILENAME] [--prelude_command COMMAND]
[--cmd_run BEHAVIOR] [--cmd_listen BEHAVIOR] [--daemon BEHAVIOR] [--cmd_run BEHAVIOR]
[--cmd_listen BEHAVIOR]
[--cmd_listen_performance BEHAVIOR] [--cmd_listen_performance BEHAVIOR]
[--cmd_listen_progress BEHAVIOR] [--cmd_listen_progress BEHAVIOR]
[--cmd_listen_power BEHAVIOR] [ARGS] [--cmd_listen_power BEHAVIOR] [--threadCount THREADS]
[ARGS]
Setup stack and check that a hello world app sends message back to cmd's Setup stack and check that a hello world app sends message back to cmd's
stdout. stdout.
...@@ -77,9 +80,12 @@ Available options: ...@@ -77,9 +80,12 @@ Available options:
--output_dir DIR Working --output_dir DIR Working
directory. (default: WorkingDirectory (FilePath "_output")) directory. (default: WorkingDirectory (FilePath "_output"))
--manifest_directory DIR Manifest lookup --manifest_directory DIR Manifest lookup
directory (default: ManifestDir (FilePath "/tmp")) directory (default: ShareDir (FilePath "/nix/store/64wmv8npkn4dx263ln853r6lvlckj07h-argotk-0.1.0.0/share"))
--manifest_name FILENAME Manifest file basename (relative to --manifest_name FILENAME Manifest file basename (relative to
--manifest_directory) (default: ManifestName (FilePath "basic.json")) --manifest_directory) (default: ManifestName (FilePath "basic.json"))
--prelude_command COMMAND
Command to run before executing the stack (after
stack setup) (default: PreludeCommand "")
--daemon BEHAVIOR `daemon` --daemon BEHAVIOR `daemon`
behavior (default: JustRun (StdOutLog "daemon_out.log") (StdErrLog "daemon_err.log")) behavior (default: JustRun (StdOutLog "daemon_out.log") (StdErrLog "daemon_err.log"))
--cmd_run BEHAVIOR `cmd run` --cmd_run BEHAVIOR `cmd run`
...@@ -94,13 +100,14 @@ Available options: ...@@ -94,13 +100,14 @@ Available options:
--cmd_listen_power BEHAVIOR --cmd_listen_power BEHAVIOR
`cmd listen --filter power` `cmd listen --filter power`
behavior (default: DontRun) behavior (default: DontRun)
--threadCount THREADS Number of threads to use when running the
stack. (default: HwThreadCount 8)
ARGS Application arguments. ARGS Application arguments.
-h,--help Show this help text -h,--help Show this help text
``` ```
### Hacking ### Hacking
- see `default.nix` - `nix-shell` provides cabal-build, ghcid, hlint
- edit `.README.md` in place of README.md and run ./shake.hs as a - edit `.README.md` in place of README.md, run ./shake.hs to generate.
pre-commit hook.
...@@ -10,6 +10,7 @@ rec { ...@@ -10,6 +10,7 @@ rec {
preCommit = pkgs.mkShell { preCommit = pkgs.mkShell {
name = "shake"; name = "shake";
ARGOTK_SHARE = "${argotk}/share";
buildInputs = [ buildInputs = [
(pkgs.haskellPackages.ghcWithPackages (p: with p; [ (pkgs.haskellPackages.ghcWithPackages (p: with p; [
argotk argotk
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment