### `argonix`

wrapper around various nix tools to override sources and provision
dependencies for argo. supports remote target machines.

#### Install

'stable' (the one tracked by argopkgs/master and used in CI):

``` {.bash}
nix-env -f "https://xgitlab.cels.anl.gov/argo/argopkgs/-/archive/master/argopkgs-master.tar.gz" -iA argonix
```

bleeding:

``` {.bash}
nix-env -I argopkgs="https://xgitlab.cels.anl.gov/argo/argopkgs/-/archive/master/argopkgs-master.tar.gz" -f "https://xgitlab.cels.anl.gov/argo/argonix/-/archive/master/argonix-master.tar.gz" -iA argonix
```

#### Usage

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

``` {.txt}
Usage: argonix COMMAND

Available options:
  COMMAND                  Type of operation to run.
  -h,--help                Show this help text

Available commands:
  build                    Run an argo-compatible nix-build.
  shell                    Enter an argo-compatible nix-shell
  remote-shell             Enter an argo-compatible nix-shell on a remote
                           machine with nix enabled
```

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

``` {.txt}
Usage: argonix shell TARGET [--argopkgs ARGOPKGS] [-v|--verbose]
                     [-s|--sandboxing] [-g|--grafting] [--experiments PATH]
                     [--aml PATH] [--libnrm PATH] [--numabench PATH]
                     [--repoquality PATH] [--excit PATH] [--nrm PATH]
                     [--containers PATH] [--argotk PATH] [--amg PATH]
                     [--lammps PATH] [--qmcpack PATH] [--stream PATH]
                     [--openmc PATH] [--argonix PATH] [--run COMMAND]
  Enter an argo-compatible nix-shell

Available options:
  TARGET                   The build target, in aml libnrm numabench repoquality
                           excit nrm containers argotk amg lammps qmcpack stream
                           openmc argonix numabench-check excit-check powerexpe
                           test report testHello testListen testListen testHello
                           testListen testPerfwrapper testPower testSTREAM
                           testAMG testOpenMC testLAMMPS testQMCPack testAll
  --argopkgs ARGOPKGS      Nix expression that produces the argopkgs source
                           path. (default: "<argopkgs>")
  -v,--verbose             Enable verbose mode
  -s,--sandboxing          Enable nix sandboxing.
  -g,--grafting            Enable libnrm grafting to avoid rebuilding
                           applications.
  --experiments PATH       experiments source folder override.
  --aml PATH               aml source folder override.
  --libnrm PATH            libnrm source folder override.
  --numabench PATH         numabench source folder override.
  --repoquality PATH       repoquality source folder override.
  --excit PATH             excit source folder override.
  --nrm PATH               nrm source folder override.
  --containers PATH        containers source folder override.
  --argotk PATH            argotk 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.
  --openmc PATH            openmc source folder override.
  --argonix PATH           argonix source folder override.
  --run COMMAND            Command to run the environment instead of an
                           interactive shell
  -h,--help                Show this help text
```

### Hacking

-   `nix-shell` provides cabal-build, ghcid, hlint

-   edit `.README.md` in place of README.md, run ./shake.hs to generate.