Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
argo
argonix
Commits
0802f5cd
Commit
0802f5cd
authored
Feb 17, 2019
by
Valentin Reis
Browse files
Readme update.
parent
578c83c5
Pipeline
#5408
passed with stage
in 1 minute and 25 seconds
Changes
2
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
.README.md
View file @
0802f5cd
### `argonix`
This is a test environment manager/remote deployment tool for Argo. It 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
[
argopkgs
](
https://xgitlab.cels.anl.gov/argo/argopkgs
)
.
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):
```
nix-env -f argopkgs="https://xgitlab.cels.anl.gov/argo/argopkgs/-/archive/master/argopkgs-master.tar.gz" -iA argonix
```
bleeding:
```
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
...
...
@@ -17,6 +27,6 @@ argonix --help
### 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
.
README.md
View file @
0802f5cd
### `argonix`
This is a test environment manager/remote deployment tool for Argo. It
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
[
argopkgs
](
https://xgitlab.cels.anl.gov/argo/argopkgs
)
.
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):
nix-env -f argopkgs="https://xgitlab.cels.anl.gov/argo/argopkgs/-/archive/master/argopkgs-master.tar.gz" -iA argonix
bleeding:
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
...
...
@@ -15,40 +22,19 @@ argonix --help
Output:
```
{.txt}
argonix
Usage: argonix [-v|--verbose] [-a|--provision_apps] [-r|--remote_build]
[--retreive RELATIVE_PATH] [--retreiveAs LOCAL_PATH]
[--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.
Usage: argonix COMMAND
Available options:
-v,--verbose Enable verbose mode
-a,--provision_apps Build and provision applications.
-r,--remote_build Build on the remote rather than locally.
--retreive RELATIVE_PATH File/Folder to retreive from the remote machine.
--retreiveAs LOCAL_PATH File/Folder to save retreived data as (locally).
--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
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-compatable nix-shell
```
### 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.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment