README.md 2.05 KB
Newer Older
Valentin Reis's avatar
Valentin Reis committed
1 2 3
### `argonix`

This is a test environment manager/remote deployment tool for Argo. It
Valentin Reis's avatar
Valentin Reis committed
4 5 6
provides a wrapper around various nix tools to override sources and
provision dependencies. Additionally, it supports providing a remote
target machine. It should be built using
Valentin Reis's avatar
Valentin Reis committed
7 8 9 10 11 12 13 14 15 16 17 18 19
[argopkgs](https://xgitlab.cels.anl.gov/argo/argopkgs).

#### Usage

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

Output:

``` {.txt}
argonix

Valentin Reis's avatar
Valentin Reis committed
20
Usage: argonix [-v|--verbose] [-a|--provision_apps] [-r|--remote_build]
Valentin Reis's avatar
Valentin Reis committed
21
               [--retreive RELATIVE_PATH] [--retreiveAs LOCAL_PATH]
Valentin Reis's avatar
Valentin Reis committed
22 23 24 25
               [--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 environment provisioning/deployment/execution.
Valentin Reis's avatar
Valentin Reis committed
26 27 28

Available options:
  -v,--verbose             Enable verbose mode
Valentin Reis's avatar
Valentin Reis committed
29 30
  -a,--provision_apps      Build and provision applications.
  -r,--remote_build        Build on the remote rather than locally.
Valentin Reis's avatar
Valentin Reis committed
31 32
  --retreive RELATIVE_PATH File/Folder to retreive from the remote machine.
  --retreiveAs LOCAL_PATH  File/Folder to save retreived data as (locally).
Valentin Reis's avatar
Valentin Reis committed
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
  --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.