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 750680cc3d402a334c4c70ac7bc98bcbfd9fdd32..58687c540121dfe9bf5e000b42045356bf497ef6 100644 --- a/doc.zih.tu-dresden.de/docs/data_lifecycle/workspaces.md +++ b/doc.zih.tu-dresden.de/docs/data_lifecycle/workspaces.md @@ -31,7 +31,7 @@ Since the workspace filesystems are intended for different use cases and thus di performance, their granted timespans differ accordingly. The maximum lifetime and number of renewals are provided in the following table. -| Filesystem (use with parameter `--filesystem=<filesystem>`) | Max. Duration in Days | Extensions | Keeptime | [Filesystem Feature](../jobs_and_resources/slurm.md#filesystem-features) | +| Filesystem (use with parameter `--filesystem <filesystem>`) | Max. Duration in Days | Extensions | Keeptime | [Filesystem Feature](../jobs_and_resources/slurm.md#filesystem-features) | |:------------------------------------------------------------|---------------:|-----------:|---------:|:-------------------------------------------------------------------------| | ` horse` | 100 | 10 | 30 | | | ` walrus` | 100 | 10 | 60 | | @@ -49,7 +49,7 @@ renewals are provided in the following table. The filesystems `warm_archive`, `ssd` and `scratch` will be switched off end of 2023. Do not use them anymore! - | Filesystem (use with parameter `--filesystem=<filesystem>`) | 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. | @@ -94,7 +94,7 @@ provides information which filesystem is available on which cluster. The output of the commands `ws_find --list` and `ws_list -l` will indicate the **default filesystem**. If you prefer another filesystem (cf. section [List Available Filesystems](#list-available-filesystems)), you have to explictly - provide the option `--filesystem=<filesystem>` to the workspace commands. If the default + provide the option `--filesystem <filesystem>` to the workspace commands. If the default filesystems is the one you want to work with, you can omit this option. ### List Current Workspaces @@ -118,7 +118,7 @@ overview of some of these options. All available options can be queried by `ws_l === "Certain filesystem" ```console - marie@login$ ws_list --filesystem=walrus + marie@login$ ws_list --filesystem walrus id: marie-numbercrunch workspace directory : /data/walrus/ws/marie-numbercrunch remaining time : 89 days 23 hours @@ -228,10 +228,10 @@ Options: === "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=walrus test-workspace 99 + marie@login$ ws_allocate --filesystem walrus test-workspace 99 Info: creating workspace. /lustre/ssd/ws/marie-test-workspace remaining extensions : 2 @@ -246,7 +246,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@tu-dresden.de test-workspace 99 + marie@login$ ws_allocate --reminder 7 --mailaddress marie@tu-dresden.de test-workspace 99 Info: creating workspace. /horse/ws/marie-test-workspace remaining extensions : 10 @@ -299,7 +299,7 @@ workspace is not forgotten. An e-mail reminder can be set at workspace allocation using ```console -ws_allocate --reminder=<N> --mailaddress=<your.email>@tu-dresden.de [...] +ws_allocate --reminder <N> --mailaddress <your.email>@tu-dresden.de [...] ``` This will send an e-mail every day starting `N` days prior to the expiration date. @@ -309,10 +309,10 @@ If you missed setting an e-mail reminder at workspace allocation, you can add a ``` # initial allocation -marie@login$ ws_allocate --name=FancyExp --duration=17 +marie@login$ ws_allocate --name FancyExp --duration 17 [...] # add e-mail reminder -marie@login$ ws_allocate --name=FancyExp --duration=17 --reminder=7 --mailaddress=<your.email>@tu-dresden.de +marie@login$ ws_allocate --name FancyExp --duration 17 --reminder 7 --mailaddress <your.email>@tu-dresden.de --extension ``` @@ -341,7 +341,7 @@ To delete a workspace use the `ws_release` command. It is mandatory to specify t workspace and the filesystem in which it is allocated: ```console -marie@login$ ws_release --filesystem=horse --name=test-workspace +marie@login$ ws_release --filesystem horse --name test-workspace ``` You can list your already released or expired workspaces using the `ws_restore --list` command. @@ -408,7 +408,7 @@ to get a list of your expired workspaces, and then restore them like that into a workspace 'new_ws': ```console -marie@login$ ws_restore --filesystem=horse marie-test-workspace-1701873807 new_ws +marie@login$ ws_restore --filesystem horse marie-test-workspace-1701873807 new_ws ``` The expired workspace has to be specified by its full name as listed by `ws_restore --list`, @@ -483,7 +483,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 (--duration). WSNAME=computation_$SLURM_JOB_ID - export WSDDIR=$(ws_allocate --filesystem=ssd --name=${WSNAME} --duration=2) + export WSDDIR=$(ws_allocate --filesystem ssd --name ${WSNAME} --duration 2) echo ${WSDIR} # Check allocation @@ -526,7 +526,7 @@ For a series of jobs or calculations that work on the same data, you should allo once, e.g., in `horse` for 100 days: ```console -marie@login$ ws_allocate --filesystem=horse my_scratchdata 100 +marie@login$ ws_allocate --filesystem horse my_scratchdata 100 Info: creating workspace. /data/horse/ws/marie-my_scratchdata remaining extensions : 10 @@ -556,7 +556,7 @@ that this is mounted read-only on the compute nodes, so you cannot use it as a w your jobs! ```console -marie@login$ ws_allocate --filesystem=walrus my_inputdata 100 +marie@login$ ws_allocate --filesystem walrus my_inputdata 100 /data/walrus/ws/marie-my_inputdata remaining extensions : 2 remaining time in days: 100 @@ -606,7 +606,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. /data/horse/ws/marie-numbercrunch remaining extensions : 10 @@ -669,15 +669,15 @@ e-mail alert functionality to an existing workspace? **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> +marie@login$ ws_allocate --extension --mailaddress <mail address> --reminder <days> \ + --name <workspace-name> --duration <duration> --filesystem <filesystem> ``` E.g. ```console -marie@login$ ws_allocate --extension --mailaddress=<your.email>@tu-dresden.de --reminder=7 \ - --name=numbercrunch --duration=20 --filesystem=horse +marie@login$ ws_allocate --extension --mailaddress <your.email>@tu-dresden.de --reminder 7 \ + --name numbercrunch --duration 20 --filesystem horse ``` This will lower the remaining extensions by one.