Skip to content

Commit 096a07e

Browse files
authored
Merge pull request #39 from xchem/uploader
Updated docs to make it clear uploader is now the preferred way
2 parents b786fe3 + d92b568 commit 096a07e

File tree

1 file changed

+25
-23
lines changed

1 file changed

+25
-23
lines changed

USER-GUIDE.md

+25-23
Original file line numberDiff line numberDiff line change
@@ -428,38 +428,17 @@ Warning: aligner can take an even longer time, please be patient.
428428

429429
## 5. Upload to Fragalysis
430430

431-
To generate the gzipped tar file needed to manually upload the data move into your version dir and run this command
432-
(updating it for the specific upload version and target name):
433-
434-
```
435-
tar cvfz <target_name>.tgz upload_1
436-
```
437-
438-
Change `upload_1` to whatever your current upload is.
439-
440-
441-
### Uploading using the API endpoint
442-
443431
**Staging vs production: there are two live versions of Fragalysis. "Staging" is used for testing and is in constant development, therefore it may be buggier and/or have new features with respect to "production" which is the stable and public deployment. You should test if your upload works in staging, and verify that the data has been uploaded correctly before uploading to production. Data in staging is "at risk" as we may have to wipe the data occassionally for development reasons.**
444432

445433
### First to log in to Fragalysis and authenticate and log in with your FedID:
446434

447435
* Staging: https://fragalysis.xchem.diamond.ac.uk/viewer/react/landing
448436
* Production: https://fragalysis.diamond.ac.uk/viewer/react/landing
449437

450-
### The gzipped tar file can then be uploaded to Fragalysis via:
451-
452-
* Staging: https://fragalysis.xchem.diamond.ac.uk/api/upload_target_experiments/
453-
* Production: https://fragalysis.diamond.ac.uk/api/upload_target_experiments
454-
455-
The target access string will be the name of your proposal in UAS/ISpyB. Any Fed ID with access to your proposal will be able to see your data. If you have a private/closed data set, this means only logged in users with access configured via UAS will see your target dataset.
456-
457-
Fill in your email and attach the `.tgz` archive. After clicking 'POST' you will see a URL which you can append to https://fragalysis.xchem.diamond.ac.uk/ (or https://fragalysis.diamond.ac.uk/ for production) to track the progress of the upload.
458-
459438

460439
### Uploading with the XCA uploader tool
461440

462-
To use the XChemAlign uploader tool, first log in to Fragalysis and obtain the authentication token. Token can be obtained from:
441+
The preferred way to upload data to Fragalysis is using the uploader tool in XChemAlign. Once you've logged in, you can obtain the authentication token from:
463442

464443
* Staging: https://fragalysis.xchem.diamond.ac.uk/api/token/
465444
* Production: https://fragalysis.diamond.ac.uk/api/token/
@@ -470,14 +449,37 @@ Then run the upload command:
470449
python -m xchemalign.uploader -u <fragalysis url> -p <proposal number> -t <token>
471450
```
472451

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
452+
This will find the latest upload directory, compress it to a tarball, and then upload it to the given URL. If the tarball already exists, the compression step can be skipped by specifying either
474453
`-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:
475454

476455
```commandline
477456
python -m xchemalign.uploader -h
478457
```
479458

480459

460+
### Uploading using the API endpoint
461+
462+
An alternative is to use the API endpoint directly. For this you need to generate the gzipped tar file and manually upload the data. Move into your version dir and run this command
463+
(updating it for the specific upload version and target name):
464+
465+
```
466+
tar cvfz <target_name>.tgz upload_1
467+
```
468+
469+
Change `upload_1` to whatever your current upload is.
470+
471+
472+
The gzipped tar file can then be uploaded to Fragalysis via:
473+
474+
* Staging: https://fragalysis.xchem.diamond.ac.uk/api/upload_target_experiments/
475+
* Production: https://fragalysis.diamond.ac.uk/api/upload_target_experiments
476+
477+
The target access string will be the name of your proposal in UAS/ISpyB. Any Fed ID with access to your proposal will be able to see your data. If you have a private/closed data set, this means only logged in users with access configured via UAS will see your target dataset.
478+
479+
Attach the `.tgz` archive by clicking the 'Choose file' button. The remaining fields, 'Data version' and 'Target name', are not necessary, these are used only by the uploader tool. After clicking 'POST' you will see a URL which you can append to https://fragalysis.xchem.diamond.ac.uk/ (or https://fragalysis.diamond.ac.uk/ for production) to track the progress of the upload.
480+
481+
482+
481483
## 6. Creating subsequent versions
482484

483485
When you have new or updated data you need to create a new version of the upload.

0 commit comments

Comments
 (0)