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

Valentin Reis's avatar
Valentin Reis committed
3 4 5 6 7 8 9
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):

Valentin Reis's avatar
Valentin Reis committed
10
``` {.bash}
Valentin Reis's avatar
Valentin Reis committed
11
nix-env -f "https://xgitlab.cels.anl.gov/argo/argopkgs/-/archive/master/argopkgs-master.tar.gz" -iA argonix
Valentin Reis's avatar
Valentin Reis committed
12
```
Valentin Reis's avatar
Valentin Reis committed
13 14 15

bleeding:

Valentin Reis's avatar
Valentin Reis committed
16 17 18
``` {.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
```
Valentin Reis's avatar
Valentin Reis committed
19 20 21 22 23 24 25 26

#### Usage

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

``` {.txt}
Valentin Reis's avatar
Valentin Reis committed
27
Usage: argonix COMMAND
Valentin Reis's avatar
Valentin Reis committed
28 29

Available options:
Valentin Reis's avatar
Valentin Reis committed
30
  COMMAND                  Type of operation to run.
Valentin Reis's avatar
Valentin Reis committed
31
  -h,--help                Show this help text
Valentin Reis's avatar
Valentin Reis committed
32 33 34

Available commands:
  build                    Run an argo-compatible nix-build.
Valentin Reis's avatar
Valentin Reis committed
35
  shell                    Enter an argo-compatible nix-shell
Valentin Reis's avatar
Valentin Reis committed
36 37
  remote-shell             Enter an argo-compatible nix-shell on a remote
                           machine with nix enabled
Valentin Reis's avatar
Valentin Reis committed
38 39 40 41 42 43 44
```

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

``` {.txt}
Valentin Reis's avatar
Valentin Reis committed
45 46
Usage: argonix shell TARGET [--argopkgs ARGOPKGS] [-v|--verbose]
                     [-s|--sandboxing] [-g|--grafting] [--aml PATH]
Valentin Reis's avatar
Valentin Reis committed
47 48 49
                     [--libnrm PATH] [--nrm PATH] [--containers PATH]
                     [--argotk PATH] [--amg PATH] [--lammps PATH]
                     [--qmcpack PATH] [--stream PATH] [--openmc PATH]
Valentin Reis's avatar
Valentin Reis committed
50
                     [--experiments PATH] [--run COMMAND]
Valentin Reis's avatar
Valentin Reis committed
51 52 53 54 55 56 57
  Enter an argo-compatible nix-shell

Available options:
  TARGET                   The build target.
  --argopkgs ARGOPKGS      Nix expression that produces the argopkgs source
                           path. (default: "<argopkgs>")
  -v,--verbose             Enable verbose mode
Valentin Reis's avatar
Valentin Reis committed
58 59 60
  -s,--sandboxing          Enable nix sandboxing.
  -g,--grafting            Enable libnrm grafting to avoid rebuilding
                           applications.
Valentin Reis's avatar
Valentin Reis committed
61 62 63 64 65 66 67 68 69 70
  --aml PATH               aml source folder override.
  --libnrm PATH            libnrm 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.
Valentin Reis's avatar
Valentin Reis committed
71
  --experiments PATH       experiments source folder override.
Valentin Reis's avatar
Valentin Reis committed
72 73 74
  --run COMMAND            Command to run the environment instead of an
                           interactive shell
  -h,--help                Show this help text
Valentin Reis's avatar
Valentin Reis committed
75 76 77 78
```

### Hacking

Valentin Reis's avatar
Valentin Reis committed
79
-   `nix-shell` provides cabal-build, ghcid, hlint
Valentin Reis's avatar
Valentin Reis committed
80

Valentin Reis's avatar
Valentin Reis committed
81
-   edit `.README.md` in place of README.md, run ./shake.hs to generate.