README.md 1.64 KB
Newer Older
Valentin Reis's avatar
Valentin Reis committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
### `argonix`

This is a test environment manager/remote deployment tool for Argo. It
provides a documented way to use various nix tools. It should be
provisioned using
[argopkgs](https://xgitlab.cels.anl.gov/argo/argopkgs).

#### Usage

``` {.bash}
argonix --help
```

Output:

``` {.txt}
argonix

Usage: argonix [-v|--verbose] [--target_machine USER@HOST] [--argotk PATH]
               [--argopkgs PATH] [--nrm PATH] [--containers PATH]
               [--libnrm PATH] [--amg PATH] [--lammps PATH] [--qmcpack PATH]
               [--stream PATH] [--run COMMAND]
  Argo test environment manager. This uses various nix tools to provision a
  local or remote environment with source overrides.

Available options:
  -v,--verbose             Enable verbose mode
  --target_machine USER@HOST
                           Target machine. defaults to localhost via forking.
  --argotk PATH            argotk source folder override.
  --argopkgs PATH          argopkgs source folder override.
  --nrm PATH               nrm source folder override.
  --containers PATH        containers source folder override.
  --libnrm PATH            libnrm source folder override.
  --amg PATH               amg source folder override.
  --lammps PATH            lammps source folder override.
  --qmcpack PATH           qmcpack source folder override.
  --stream PATH            stream source folder override.
  --run COMMAND            Command to run the environment instead of an
                           interactive shell
  -h,--help                Show this help text
```

### Hacking

-   see `default.nix`

-   edit `.README.md` in place of README.md and run ./shake.hs as a
    pre-commit hook.