diff --git a/doc.zih.tu-dresden.de/docs/data_lifecycle/workspaces.md b/doc.zih.tu-dresden.de/docs/data_lifecycle/workspaces.md index 46ff6483a19cb37e73f6403fc5d300bb6fb9fc95..924d98077b2489ba5f2516f3e21fe49004747ad2 100644 --- a/doc.zih.tu-dresden.de/docs/data_lifecycle/workspaces.md +++ b/doc.zih.tu-dresden.de/docs/data_lifecycle/workspaces.md @@ -44,7 +44,7 @@ beegfs The default filesystem is `scratch`. If you prefer another filesystem (cf. section [List Available Filesystems](#list-available-filesystems)), you have to explictly - provide the option `--filesystem=<fs>` to the workspace commands. + provide the option `--filesystem=<filesystem>` to the workspace commands. ### List Current Workspaces @@ -171,10 +171,10 @@ Options: !!! example "Workspace allocation on specific filesystem" In order to allocate a workspace on a non-default filesystem, the option - `--filesystem <filesystem>` is required. + `--filesystem=<filesystem>` is required. ```console - marie@login$ ws_allocate --filesystem scratch_fast test-workspace 3 + marie@login$ ws_allocate --filesystem=scratch_fast test-workspace 3 Info: creating workspace. /lustre/ssd/ws/marie-test-workspace remaining extensions : 2 @@ -188,7 +188,7 @@ Options: day starting 7 days prior to expiration. We strongly recommend setting this e-mail reminder. ```console - marie@login$ ws_allocate --reminder 7 --mailaddress marie.testuser@tu-dresden.de test-workspace 90 + marie@login$ ws_allocate --reminder=7 --mailaddress=marie.testuser@tu-dresden.de test-workspace 90 Info: creating workspace. /scratch/ws/marie-test-workspace remaining extensions : 10 @@ -209,7 +209,7 @@ group workspaces. The lifetime of a workspace is finite and different filesystems (storage systems) have different maximum durations. A workspace can be extended multiple times, depending on the filesystem. -| Filesystem (use with parameter `--filesystem=<fs>`) | Duration, days | Extensions | [Filesystem Feature](../jobs_and_resources/slurm.md#filesystem-features) | Remarks | +| Filesystem (use with parameter `--filesystem=<filesystem>`) | Duration, days | Extensions | [Filesystem Feature](../jobs_and_resources/slurm.md#filesystem-features) | Remarks | |:-------------------------------------|---------------:|-----------:|:-------------------------------------------------------------------------|:--------| | `scratch` (default) | 100 | 10 | `fs_lustre_scratch2` | Scratch filesystem (`/lustre/scratch2`, symbolic link: `/scratch`) with high streaming bandwidth, based on spinning disks | | `ssd` | 30 | 2 | `fs_lustre_ssd` | High-IOPS filesystem (`/lustre/ssd`, symbolic link: `/ssd`) on SSDs. | @@ -433,7 +433,7 @@ the following example (which works [for the program g16](../software/nanoscale_s # Allocate workspace for this job. Adjust time span to time limit of the job (-d <N>). WSNAME=computation_$SLURM_JOB_ID - export WSDDIR=$(ws_allocate -F ssd -n ${WSNAME} -d 2) + export WSDDIR=$(ws_allocate --filesystem=ssd --name=${WSNAME} --duration=2) echo ${WSDIR} # Check allocation @@ -476,7 +476,7 @@ For a series of jobs or calculations that work on the same data, you should allo once, e.g., in `scratch` for 100 days: ```console -marie@login$ ws_allocate -F scratch my_scratchdata 100 +marie@login$ ws_allocate --filesystem=scratch my_scratchdata 100 Info: creating workspace. /scratch/ws/marie-my_scratchdata remaining extensions : 2 @@ -505,7 +505,7 @@ this is mounted read-only on the compute nodes, so you cannot use it as a work d jobs! ```console -marie@login$ ws_allocate -F warm_archive my_inputdata 365 +marie@login$ ws_allocate --filesystem=warm_archive my_inputdata 365 /warm_archive/ws/marie-my_inputdata remaining extensions : 2 remaining time in days: 365 @@ -551,7 +551,7 @@ to others (if in the same group) via `ws_list -g`. in the project `p_number_crunch`, she can allocate a so-called group workspace. ```console - marie@login$ ws_allocate --group --name numbercrunch --duration 30 + marie@login$ ws_allocate --group --name=numbercrunch --duration=30 Info: creating workspace. /scratch/ws/0/marie-numbercrunch remaining extensions : 10 @@ -610,6 +610,11 @@ wrong name. Use only the short name that is listed after `id:` when using `ws_li **Q**: I forgot to specify an e-mail alert when allocating my workspace. How can I add the e-mail alert functionality to an existing workspace? -**A**: You can add the e-mail alert by "overwriting" the workspace settings via `ws_allocate -x -m -<mail address> -r <days> -n <ws-name> -d <duration> -F <fs>`. (This will lower the remaining -extensions by one.) +**A**: You can add the e-mail alert by "overwriting" the workspace settings via + +```console +marie@login$ ws_allocate --extension --mailaddress=<mail address> --reminder=<days> \ + --name=<workspace-name> --duration=<duration> --filesystem=<filesystem> +``` + +This will lower the remaining extensions by one.