Skip to content

Commit 9476f28

Browse files
committed
feat: compression options and stack nicknames
Stack url can now be specified (if defined in the environment!) using nicknames, such as staging or production. To define the nicknames in environment add an environment variable with a prefix XCHEMALIGN_FRAGALYSIS_URL_, the script will use this to find the urls. For example the variable XCHEMALIGN_FRAGALYSIS_URL_PRODUCTION=https://fragalysis.diamond.ac.uk will set nickname 'production' to point to an url https://fragalysis.diamond.ac.uk (i.e. everything after the prefix in lowercase will become the nickname) Another feature is the compression. The scipt will now handle the data compression itself (the default) and will use an existing tarball only if instructed.
1 parent 2151b78 commit 9476f28

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
@@ -451,7 +451,14 @@ To use the XChemAlign uploader tool, first log in to Fragalysis and obtain the a
451451
Then run the upload command:
452452

453453
```commandline
454-
python -m xchemalign.uploader -i <gzipped tar file> -u <fragalysis url> -p <proposal number> -t <token>
454+
python -m xchemalign.uploader -u <fragalysis url> -p <proposal number> -t <token>
455+
```
456+
457+
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
458+
`-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:
459+
460+
```commandline
461+
python -m xchemalign.uploader -h
455462
```
456463

457464

0 commit comments

Comments
 (0)