Skip to content

Commit 150d659

Browse files
committed
Change staging examples to new directory structure
1 parent b13f4f0 commit 150d659

File tree

8 files changed

+41
-45
lines changed

8 files changed

+41
-45
lines changed

_uw-research-computing/apptainer-htc.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ exit
138138
Once you are satisfied that your container is built correctly, copy your `.sif` file to your staging directory.
139139

140140
```
141-
mv my-container.sif /staging/$USER
141+
mv my-container.sif /staging/u/username
142142
```
143143
{:.term}
144144

@@ -314,7 +314,7 @@ Since Apptainer `.sif` files are routinely more than 1GB in size, we recommend t
314314
It is usually easiest to move the container file directly to staging while still in the interactive build job:
315315

316316
```
317-
mv my-container.sif /staging/$USER
317+
mv my-container.sif /staging/u/username
318318
```
319319
{:.term}
320320

_uw-research-computing/check-quota.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,9 @@ This will print a table with your `/home` and `/staging` quotas. An example outp
5353

5454
```
5555
[user@ap2002 ~]$ get_quotas
56-
Path Disk_Used(GB) Disk_Limit(GB) Files_Used File_Limit
57-
/home/user 16.0711 40 8039 N/A
58-
/staging/user 13.4731 100 12 1000
56+
Path Disk_Used(GB) Disk_Limit(GB) Files_Used File_Limit
57+
/home/username 16.0711 40 8039 N/A
58+
/staging/u/username 13.4731 100 12 1000
5959
```
6060
{:.term}
6161

@@ -119,10 +119,10 @@ _____________________________________________________________________
119119
== NOTICE: THIS NODE IS ON PUPPET ENVIRONMENT "puppet8" ==
120120
121121
Filesystem quota report (last updated 10:33 AM)
122-
Storage Used (GB) Limit (GB) Files (#) File Cap (#) Quota (%)
123-
------------------ ----------- ------------ ----------- -------------- -----------
124-
/home/user 29.38 40 94 0 73.46
125-
/staging/user 50.23 1000 110 10000 5.02
122+
Storage Used (GB) Limit (GB) Files (#) File Cap (#) Quota (%)
123+
------------------ ----------- ------------ ----------- -------------- -----------
124+
/home/username 29.38 40 94 0 73.46
125+
/staging/u/username 50.23 1000 110 10000 5.02
126126
```
127127
{:.term}
128128

_uw-research-computing/file-avail-largedata.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ When submitting jobs to the HTC system, large data needs to be stored and handle
2626
* [Intended use](#intended-use)
2727
* [User responsibilities](#user-responsibilities)
2828
- [Stage large data](#stage-large-data)
29-
* [Request a `/staging` directory](#request-a-staging-directory)
29+
* [Your personal `/staging` directory](#your-personal-staging-directory)
3030
* [Reduce file counts](#reduce-file-counts)
3131
* [Use the transfer server](#use-the-transfer-server)
3232
* [Remove files after jobs complete](#remove-files-after-jobs-complete)
@@ -67,18 +67,24 @@ CHTC staff reserve the right to remove data from our large data staging location
6767

6868
In order to stage large data for use on CHTC's HTC system, users must:
6969

70-
1. **Request a `/staging` directory**: Use our quota request form.
7170
1. **Reduce file counts**: Combine and compress files that are used together.
7271
1. **Transfer files to the HTC system via the transfer server**: Upload your data via our dedicated file transfer server.
7372
1. **Remove files after jobs complete**: Our data staging space is quota-controlled and not backed up.
7473

75-
### Request a `/staging` directory
74+
### Your personal `/staging` directory
7675

77-
Any one with a CHTC account whose data meets the intended use above can request space in our large data staging area by filling out a quota request form. The default quota is 100 GB / 1000 items; if a larger quota is needed, request a higher quota. The created directory will exist at this path: `/staging/username`
76+
Each user should have a personal `/staging` directory. The created directory will exist in an alphabetized subdirectory based on the **first letter** of your NetID. For example:
77+
78+
| NetID | Path to your personal `/staging` directory |
79+
| --- | --- |
80+
| `alice` | `/staging/a/alice` |
81+
| `bucky` | `/staging/b/bucky` |
7882

7983
We can also create group or shared spaces by request.
8084

81-
<p style="text-align: center; margin-bottom: 0; font-weight: bold;">Need a <code>/staging</code> directory or higher quota?</p>
85+
The default quota is 100 GB / 1000 items; if a larger quota is needed, request a higher quota.
86+
87+
<p style="text-align: center; margin-bottom: 0; font-weight: bold;">Need a group <code>/staging</code> directory or higher quota?</p>
8288
<div class="d-flex mb-3">
8389
<div class="p-3 m-auto">
8490
<a class="btn btn-primary" style="text-align: center" href="quota-request">Quota request form</a>
@@ -88,7 +94,7 @@ We can also create group or shared spaces by request.
8894

8995
### Reduce file counts
9096

91-
The file system backing our `/staging`space is optimized to handle small numbers of large files. If your job requires many small files, we recommend placing these files in the `/home` directory or compressing multiple files into a single zip file or tarball. See [this table](htc-job-file-transfer#data-storage-locations) for more information on the differences between `/staging` and `/home`.
97+
The file system backing our `/staging` space is optimized to handle small numbers of large files. If your job requires many small files, we recommend placing these files in the `/home` directory or compressing multiple files into a single zip file or tarball. See [this table](htc-job-file-transfer#data-storage-locations) for more information on the differences between `/staging` and `/home`.
9298

9399
Data placed in our large data `/staging` location should be stored in as few files as possible (ideally, one file per job), and will be used by a job only after being copied from `/staging` into the job working directory. Similarly, large output should first be written to the job's working directory then compressed in to a single file before being copied to `/staging` at the end of the job.
94100

@@ -105,7 +111,7 @@ Uploading or downloading data to `/staging` should only be performed via CHTC's
105111

106112
For example, you can use `scp` to transfer files into your `/staging` directory:
107113
```
108-
$ scp large.file netid@transfer.chtc.wisc.edu:/staging/netid/
114+
$ scp large.file username@transfer.chtc.wisc.edu:/staging/u/username/
109115
```
110116
{:.term}
111117

@@ -123,7 +129,7 @@ Staged files should be specified in the job submit file using the `osdf:///` or
123129
depending on the size of the files to be transferred. [See this table for more information](htc-job-file-transfer#transfer-input-data-to-jobs-with-transfer_input_files).
124130

125131
```
126-
transfer_input_files = osdf:///chtc/staging/username/file1, file:///staging/username/file2, file3
132+
transfer_input_files = osdf:///chtc/staging/u/username/file1, file:///staging/u/username/file2, file3
127133
```
128134
{:.sub}
129135

@@ -136,7 +142,7 @@ Large outputs should be transferred to staging using the same file transfer prot
136142

137143
```
138144
transfer_output_files = file1, file2, file3
139-
transfer_output_remaps = "file1 = osdf:///chtc/staging/username/file1; file2 = file:///staging/username/file2"
145+
transfer_output_remaps = "file1 = osdf:///chtc/staging/u/username/file1; file2 = file:///staging/u/username/file2"
140146
```
141147
{:.sub}
142148

@@ -166,14 +172,14 @@ within the user's `/home` directory:
166172
``` {.sub}
167173
### Example submit file for a single job that stages large data
168174
# Files for the below lines MUST all be somewhere within /home/username,
169-
# and not within /staging/username
175+
# and not within /staging/u/username
170176
171177
executable = run_myprogram.sh
172178
log = myprogram.log
173179
output = $(Cluster).out
174180
error = $(Cluster).err
175181
176-
transfer_input_files = osdf:///chtc/staging/username/myprogram, file:///staging/username/largedata.tar.gz
182+
transfer_input_files = osdf:///chtc/staging/u/username/myprogram, file:///staging/u/username/largedata.tar.gz
177183
178184
# IMPORTANT! Require execute servers that can access /staging
179185
Requirements = (Target.HasCHTCStaging == true)

_uw-research-computing/high-memory-jobs.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -174,16 +174,13 @@ Altogether, a sample submit file may look something like this:
174174
``` {.sub}
175175
### Example submit file for a single staging-dependent job
176176
177-
universe = vanilla
178-
179177
# Files for the below lines will all be somewhere within /home/username,
180-
# and not within /staging/username
178+
# and not within /staging/u/username
181179
log = run_myprogram.log
182180
executable = run_Trinity.sh
183181
output = $(Cluster).out
184182
error = $(Cluster).err
185183
transfer_input_files = trinityrnaseq-2.0.1.tar.gz
186-
should_transfer_files = YES
187184
188185
# Require execute servers that have large data staging
189186
Requirements = (Target.HasCHTCStaging == true)
@@ -236,7 +233,7 @@ Altogether, a sample script may look something like this (perhaps called
236233
#!/bin/bash
237234
# Copy input data from /staging to the present directory of the job
238235
# and un-tar/un-zip them.
239-
cp /staging/username/reads.tar.gz ./
236+
cp /staging/u/username/reads.tar.gz ./
240237
tar -xzvf reads.tar.gz
241238
rm reads.tar.gz
242239
@@ -255,7 +252,7 @@ Trinity --seqType fq --left reads_1.fq \
255252
# Trinity will write output to the working directory by default,
256253
# so when the job finishes, it needs to be moved back to /staging
257254
tar -czvf trinity_out_dir.tar.gz trinity_out_dir
258-
cp trinity_out_dir.tar.gz trinity_stdout.txt /staging/username/
255+
cp trinity_out_dir.tar.gz trinity_stdout.txt /staging/u/username/
259256
rm reads_*.fq trinity_out_dir.tar.gz trinity_stdout.txt
260257
261258
### END

_uw-research-computing/htc-docker-to-apptainer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ INFO: Build complete: container.sif
7878
Because container images are generally large, we require users to move these images into their staging directories. While you are still in your interactive job, move the image to your staging directory.
7979

8080
```
81-
mv container.sif /staging/username/
81+
mv container.sif /staging/u/username/
8282
```
8383
{:.term}
8484

_uw-research-computing/htc-job-file-transfer.md

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,6 @@ The HTC system has two primary locations where users can place their files:
4242

4343
The data management mechanisms behind `/home` and `/staging` are different and are optimized to handle different file sizes and numbers of files. It's important to place your files in the correct location to improve the efficiency at which your data is handled and maintain the stability of the HTC file systems.
4444

45-
<p style="text-align: center; margin-bottom: 0; font-weight: bold;">Need a <code>/staging</code> directory?</p>
46-
<div class="d-flex mb-3">
47-
<div class="p-3 m-auto">
48-
<a class="btn btn-primary" style="text-align: center" href="quota-request">Request one here</a>
49-
</div>
50-
</div>
51-
5245

5346
## Transfer input data to jobs with `transfer_input_files`
5447

@@ -57,8 +50,8 @@ To transfer files to jobs, we must specify these files with `transfer_input_file
5750
| Input File Size (Per File)* | File Location | Submit File Syntax to Transfer to Jobs |
5851
| ----------- | ----------- | ----------- | ----------- |
5952
| 0 - 1 GB | `/home` | `transfer_input_files = input.txt` |
60-
| 1 - 30 GB | `/staging` | `transfer_input_files = osdf:///chtc/staging/NetID/input.txt` |
61-
| 30 - 100 GB | `/staging` | `transfer_input_files = file:///staging/NetID/input.txt` |
53+
| 1 - 30 GB | `/staging` | `transfer_input_files = osdf:///chtc/staging/u/username/input.txt` |
54+
| 30 - 100 GB | `/staging` | `transfer_input_files = file:///staging/u/username/input.txt` |
6255
| 1 - 100 GB | `/staging/groups`<sup>†</sup> | `transfer_input_files = file:///staging/groups/group_dir/input.txt` |
6356
| 100 GB+ | | Contact the facilitation team about the best strategy to stage your data |
6457

@@ -73,7 +66,7 @@ Multiple input files and file transfer protocols can be specified and delimited
7366
```
7467
# My job submit file
7568
76-
transfer_input_files = file1, osdf:///chtc/staging/username/file2, file:///staging/username/file3, dir1, dir2/
69+
transfer_input_files = file1, osdf:///chtc/staging/u/username/file2, file:///staging/u/username/file3, dir1, dir2/
7770
7871
requirements = (HasCHTCStaging == true)
7972
@@ -120,7 +113,7 @@ transfer_output_files = output_file, output/output_file2, output/output_file3
120113
121114
To transfer files back to `/staging` or a specific directory in `/home`, you will need an additional line in your HTCondor submit file, with each item separated by a semicolon (;):
122115
```
123-
transfer_output_remaps = "output_file = osdf:///chtc/staging/NetID/output1.txt; output_file2 = /home/netid/outputs/output_file2"
116+
transfer_output_remaps = "output_file = osdf:///chtc/staging/u/username/output1.txt; output_file2 = /home/u/username/outputs/output_file2"
124117
```
125118
{:.sub}
126119
@@ -133,7 +126,7 @@ Make sure to only include one set of quotation marks that wraps around the infor
133126
If you want to transfer *all* files to a specific destination, use `output_destination`:
134127
135128
```
136-
output_destination = osdf:///chtc/staging/netid/
129+
output_destination = osdf:///chtc/staging/u/username/
137130
```
138131
{:.sub}
139132
@@ -146,7 +139,7 @@ The `osdf:///` file transfer plugin is powered by the [Pelican Platform](https:/
146139
To transfer and unpack files, append a `?pack=auto` at the end of the plugin path of the compressed object to be transferred.
147140
148141
```
149-
transfer_input_files = osdf:///chtc/staging/netid/filename.tar.gz?pack=auto, input1.txt, input2.txt
142+
transfer_input_files = osdf:///chtc/staging/u/username/filename.tar.gz?pack=auto, input1.txt, input2.txt
150143
```
151144
152145
This feature is only availble for Pelican-based plugins (`osdf://`, `pelican://`) and is not available for `file://` or normal file transfers. This feature is also not recommended for compressed files larger than 30 GB.

_uw-research-computing/htc-overview.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -163,9 +163,9 @@ Each of the disk space values are given in megabytes (MB), which can be converte
163163

164164
### Check `/staging` Quota and Usage
165165

166-
To see your `/staging` quota and usage, use the `get_quotas <NetID>` command. For example,
166+
To see your `/staging` quota and usage, use the `get_quotas` command. For example,
167167
```
168-
[NetID@ap2001 ~]$ get_quotas /staging/NetID
168+
[NetID@ap2001 ~]$ get_quotas
169169
```
170170
{:.term}
171171

@@ -178,8 +178,8 @@ Alternatively, the `ncdu` command can also be used to see how many
178178
files and directories are contained in a given path:
179179

180180
```
181-
[NetID@ap2001 ~]$ ncdu /home/NetID
182-
[NetID@ap2001 ~]$ ncdu /staging/NetID
181+
[NetID@ap2001 ~]$ ncdu /home/username
182+
[NetID@ap2001 ~]$ ncdu /staging/u/username
183183
```
184184
{:.term}
185185

_uw-research-computing/htc-uwdf-researchdrive.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ transfer_output_files = outputfile1.txt, outputfile2.txt, outputfile3.txt
8484
You can use `transfer_output_remaps` to place files in different locations:
8585

8686
```
87-
transfer_output_remaps = "outputfile1.txt = pelican://chtc.wisc.edu/researchdrive/<PI NetID>/CHTC/outputfile1.txt; outputfile2.txt = osdf:///chtc/staging/<NetID>/outputfile2.txt"
87+
transfer_output_remaps = "outputfile1.txt = pelican://chtc.wisc.edu/researchdrive/<PI NetID>/CHTC/outputfile1.txt; outputfile2.txt = osdf:///chtc/staging/u/username/outputfile2.txt"
8888
```
8989

9090
The example above remaps the output files such that only `outputfile1.txt` is placed in ResearchDrive, `outputfile2.txt` is placed in `/staging`, and `outputfile3.txt` is placed in the submit directory on `/home`.

0 commit comments

Comments
 (0)