Skip to content

Commit b91613e

Browse files
committed
docs: document -w/--parallel-files and iProX Aspera for PX downloads
1 parent 8a56efc commit b91613e

1 file changed

Lines changed: 51 additions & 0 deletions

File tree

docs/usage.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,58 @@ pridepy download-px-raw-files \
239239
| --- | --- | --- |
240240
| `-a, --accession` | ProteomeXchange accession (e.g. `PXD039236`). `--px` is a deprecated alias | required |
241241
| `-o, --output-folder` | Destination directory | required |
242+
| `-p, --protocol` | Transfer protocol: `ftp`, `aspera`, `globus`, `s3` (FTP-first with fallback) | `ftp` |
243+
| `-w, --parallel-files` | Download 1–32 files concurrently (across-file concurrency) | `1` |
244+
| `-t, --threads` | Parallel HTTP Range threads per file (1–32) for fast per-file downloads | `1` |
242245
| `--skip-if-downloaded-already` | Skip files already present locally | off |
246+
| `--preserve-structure` | Recreate the dataset's subdirectory layout under the output folder | off |
247+
| `--iprox-user` | iProX account username (with `--protocol aspera`; env fallback: `IPROX_USER`) ||
248+
| `--iprox-password` | iProX account password (with `--protocol aspera`; env fallback: `IPROX_ASPERA_PASSWORD`) ||
249+
250+
### Fast downloads: parallel files and per-file segments
251+
252+
Combine `-w` (files in parallel) and `-t` (Range segments per file) for fast bulk downloads.
253+
The total concurrent connections is approximately `parallel_files × threads`.
254+
255+
**Parallel across files (recommended for most users, no account required):**
256+
257+
```bash
258+
# Download up to 8 files concurrently from ProteomeXchange
259+
pridepy download-px-raw-files \
260+
-a PXD077178 \
261+
-o ./PXD077178 \
262+
-w 8
263+
```
264+
265+
**Combine parallel files with per-file segments:**
266+
267+
```bash
268+
# Download 8 files in parallel, each split into 4 Range segments
269+
pridepy download-px-raw-files \
270+
-a PXD077178 \
271+
-o ./out \
272+
-w 8 \
273+
-t 4
274+
```
275+
276+
### Fast downloads with iProX Aspera (account required)
277+
278+
iProX offers Aspera (`faspe://`) for very large bulk transfers. Aspera is faster
279+
than HTTP on high-bandwidth connections but requires an iProX account. Combine
280+
`--protocol aspera` with `--iprox-user` and `--iprox-password`:
281+
282+
```bash
283+
# Download via iProX Aspera with 8-file parallelism
284+
IPROX_ASPERA_PASSWORD=your_password pridepy download-px-raw-files \
285+
-a PXD077178 \
286+
-o ./out \
287+
--protocol aspera \
288+
--iprox-user your_username \
289+
-w 8
290+
```
291+
292+
The password is best supplied via the `IPROX_ASPERA_PASSWORD` environment variable
293+
to avoid exposing it on the command line.
243294

244295
### Go directly to the hosting repository (native MassIVE / JPOST / iProX accessions)
245296

0 commit comments

Comments
 (0)