213228b3ff324566a9dca61f7683a1ab957359ee
client_install.md
| ... | ... | @@ -1,8 +1,11 @@ |
| 1 | 1 | ## SBGrid installation manager |
| 2 | 2 | |
| 3 | -The SBGrid softare collection can be installed using our graphical installation manager for Apple OSX computers running MacOSX v10.13 - 10.15. |
|
| 3 | +The SBGrid installation manager is available as command-line tool for macOS and Linux, and as a graphical application for macOS. The command-line and graphical versions are not mutually exclusive - they can be used interchangeably on mac. |
|
| 4 | 4 | |
| 5 | -**BIOGRIDS users** - [ Instructions can be found here ](https://biogrids.org/wiki/client_install) . |
|
| 5 | +For the latest command-line application, [see here](sbgrid-cli). |
|
| 6 | +For the graphical version, see below. |
|
| 7 | + |
|
| 8 | +**NOTE for BIOGRIDS users** - [ Instructions for BioGrids installation can be found here ](https://biogrids.org/wiki/client_install) . |
|
| 6 | 9 | |
| 7 | 10 |  |
| 8 | 11 |
sbgrid-cli.md
| ... | ... | @@ -189,7 +189,7 @@ The *info* subcommand shows information about each title, including a descriptio |
| 189 | 189 | sbgrid-cli info <title...> [OPTIONS...] |
| 190 | 190 | ``` |
| 191 | 191 | |
| 192 | -For example, info for RELION : |
|
| 192 | +For example, info for *RELION* : |
|
| 193 | 193 | |
| 194 | 194 | ``` |
| 195 | 195 | $ sbgrid-cli info relion |
| ... | ... | @@ -274,7 +274,7 @@ Install and remove titles with the `sbgrid-cli install <title>` and `sbgrid-cli |
| 274 | 274 | |
| 275 | 275 | INSTALLATION EXAMPLES |
| 276 | 276 | |
| 277 | -Install a single default version of an application, `adxv` : |
|
| 277 | +Install a single default version of an application, *adxv* : |
|
| 278 | 278 | |
| 279 | 279 | ``` |
| 280 | 280 | $ sbgrid-cli install adxv |
| ... | ... | @@ -287,13 +287,13 @@ info: (2/2) Setting up your installation... |
| 287 | 287 | $ |
| 288 | 288 | ``` |
| 289 | 289 | |
| 290 | -Install a specific version of a adxv : |
|
| 290 | +Install a specific version of a *adxv* : |
|
| 291 | 291 | |
| 292 | 292 | ``` |
| 293 | 293 | $ sbgrid-cli install adxv@1.9.11 |
| 294 | 294 | ``` |
| 295 | 295 | |
| 296 | -Install all versions of adxv : |
|
| 296 | +Install all versions of *adxv* : |
|
| 297 | 297 | |
| 298 | 298 | ``` |
| 299 | 299 | $ sbgrid-cli install adxv --all-versions |
| ... | ... | @@ -347,7 +347,9 @@ Use the clean subcommand to list or remove obsolete versions or titles |
| 347 | 347 | sbgrid-cli clean [OPTIONS...] |
| 348 | 348 | ``` |
| 349 | 349 | |
| 350 | -### Advanced modes |
|
| 350 | +### Additional subcommands |
|
| 351 | + |
|
| 352 | +`sbgrid-cli` provides additional subcommands for automated software colletion maintenance and troubleshooting. |
|
| 351 | 353 | |
| 352 | 354 | **admin** |
| 353 | 355 | |
| ... | ... | @@ -426,6 +428,10 @@ sbgrid-cli list --darwin |
| 426 | 428 | This will list all software available for macOS. |
| 427 | 429 | The platform flag ( `--linux` or `--darwin`) is implied for the platform used to install the software, i.e. on linux, `--linux` is redundant. |
| 428 | 430 | |
| 431 | +### Logging |
|
| 432 | + |
|
| 433 | +`sbgrid-cli` writes log files to `$HOME/.sbgrid/logs` |
|
| 434 | + |
|
| 429 | 435 | ### Software Version Management in the SBGrid environment |
| 430 | 436 | If you have a single version of an application installed, explicit version selection in your environment is not needed. |
| 431 | 437 |