Skip to content

Commit b786fe3

Browse files
authored
Merge pull request #38 from xchem/uploader
Compression options and stack nicknames
2 parents 3c09d37 + 9476f28 commit b786fe3

File tree

2 files changed

+292
-29
lines changed

2 files changed

+292
-29
lines changed

USER-GUIDE.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -467,7 +467,14 @@ To use the XChemAlign uploader tool, first log in to Fragalysis and obtain the a
467467
Then run the upload command:
468468

469469
```commandline
470-
python -m xchemalign.uploader -i <gzipped tar file> -u <fragalysis url> -p <proposal number> -t <token>
470+
python -m xchemalign.uploader -u <fragalysis url> -p <proposal number> -t <token>
471+
```
472+
473+
This will find the latest upload directory, compress it to a tarball, and then upload it to a given URL. If the tarball already exists, the compression step can be skipped by specifying either
474+
`-d` or `-c <path to custom tarball>` parameters. Instead of a full URL, a stack nickname can be used, if defined in the environment. To see the nicknames available, use the help command:
475+
476+
```commandline
477+
python -m xchemalign.uploader -h
471478
```
472479

473480

0 commit comments

Comments
 (0)