Skip to Content

Changes for page 05. Data processing

Last modified by tabermah on 2024-12-11 11:17
From version 44.1
edited by tabermah
on 2024-12-09 13:48
Change comment: There is no comment for this version
To version 8.1
edited by janmeyer
on 2020-11-11 12:52
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -05. Data processing
1 +10. Data processing
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.tabermah
1 +XWiki.janmeyer
Content
... ... @@ -1,138 +1,44 @@
1 -{{toc/}}
1 +\\
2 2  
3 -= 5.1. Automatic data processing =
3 +**10.1. Automatic data processing**
4 4  
5 -Unless you un-check the option for the specific acquisition run, autoprocessing will be executed. For standard rotational data autoprocessing is via XDSAPP ([[https:~~/~~/www.helmholtz-berlin.de/forschung/oe/ps/macromolecular-crystallography/hzb-mx-software/xdsapp3/index_en.html>>url:https://www.helmholtz-berlin.de/forschung/oe/ps/macromolecular-crystallography/hzb-mx-software/xdsapp3/index_en.html||shape="rect"]], current version 3.1.9) (Sparta et al. (2016) //J. Apple. Cryst.// **49**, 1085-1092) for strategy calculation we use Mosflm (Leslie //Acta D//**62** (2006) 48-57) and Spotfinder ((% style="color:#000000; text-decoration:none" %)Zhang et al. (2006) (% style="text-align:left; text-decoration:none" %)//J. Appl. Cryst.//(% style="color:#000000; text-decoration:none" %) (% style="text-align:left; text-decoration:none" %)**39**(% style="color:#000000; text-decoration:none" %), 112–119)(%%) for producing the heatmap for the grid scans. The results are compiled into HTML-files to give you a convenient way of checking them. The output files are in the processed folders of the corresponding datasets.  A self refreshing index of all results is created in the beamtimes processed folder. During the beamtime you can open it from file::~/~//gpfs/current/processed/index.html in a browser. The HTML-file is also contained in your data backup.
5 +Results of the automatic data processing are only available during the beamtime. To see the data presenter, open a Browser (Open Terminal and type:(% style="color: rgb(51,153,102);" %) firefox(%%)) and type(% style="color: rgb(51,153,102);" %) /gpfs/current/processed/index.html.
6 6  
7 -= 5.2. Manual data processing =
8 8  
9 -Please do not use the control computers of the beamline (haspp11user01-04) nor the haspp11eval01 for data processing (latter is now fully dedicated to autoprocessing).
8 +\\**10.2. Download your data during or after the beamtime**
10 10  
11 -Use Maxwell-cluster for data processing as described in the next chapter. Access to Maxwell requires a Scientific Account.
10 + Data are available for download via ftp protocol on the [[Gamma portal>>url:https://gamma-portal.desy.de/||shape="rect"]] as it is described in [[here>>doc:ASAP3.The Gamma Portal.WebHome||shape="rect"]].
12 12  
13 -Manual data processing after the beamtime or during a remote session is only available for registered [[DESY Scientific Accounts>>https://xwiki.desy.de/xwiki/bin/view/FSEC/FS-IT%20Topics/Science%20Accounts/||shape="rect"]].
12 +\\
14 14  
15 -(% style="text-decoration: none;" %)
16 -== Prerequisites ==
14 +**10.3. Manual data processing during your beamtime**
17 17  
18 -(% style="text-align: justify;" %)
19 -Local users can perform manual data processing as described at the beamline. Users having remote access can also process their data only if they are through their [[DESY Science Accounts>>https://xwiki.desy.de/xwiki/bin/view/FSEC/FS-IT%20Topics/Science%20Accounts/||shape="rect" style="text-decoration: none;"]]. Users may apply for science accounts to analyze data measured at Petra III or Flash on resources located at the DESY computer center. Science accounts have a standard lifetime of 3 years (renewable).
16 +Open a terminal (see session 3.2) and type ssh haspp11eval01. You need to open one terminal and ssh to haspp11eval01 for every program you want to use.
20 20  
21 -(% style="text-align: justify;" %)
22 -**Applying for a Science Account:**
18 +To use crystallographic programs:
23 23  
24 -1. the user submits a request to the beamline scientist/manager
25 -1. the user receives a pre-filled form by Email within a few business days from the DESY-FS Administrator
26 -1. the form has to be signed and sent back to the Administrator (hard-copy as scan/photo by email/fax in pdf format)
27 -1. the user receives the initial credentials from the beamline scientist/manager who forwarded the account request. If on site at DESY, the user can authenticate him-/herself by valid ID card or passport at FS-EC's Administrators to retrieve the initial password for the account.
20 +* for XDSAPP type in the terminal (% style="color: rgb(0,128,0);" %)xdsapp
21 +* for imosflm type in the terminal (% style="color: rgb(0,128,0);" %)imosflm
22 +* for CCP4 type in the terminal (% style="color: rgb(0,128,0);" %)ccp4i
23 +* for phenix type in the terminal (% style="color: rgb(0,128,0);" %)phenix
28 28  
29 -**Multi Factor Authentication (MFA) at DESY:**
25 +**10.4. Manual data processing after your beamtime**
30 30  
31 -For accessing the DESY computers a two-factor authentication is needed. After you have received your Science Account, you will need to setup an Authenticator App to your smartphone. You can find the instructions [[here>>url:https://it.desy.de/services/mfa/external_people/index_eng.html||shape="rect" style="text-decoration: none;"]].
27 +Manual data processing after the beamtime is only available for registered [[DESY Science Accounts>>doc:FSEC.Science Accounts.WebHome||shape="rect"]].
32 32  
33 -(% style="text-decoration: none;" %)
34 -== Accessing Data ==
35 -
36 -(% style="text-align: justify;" %)
37 -There are three methods to access DESY computers from outside using a scientific account:
38 -
39 -1. **Command line:**
40 -in a Linux terminal or Cygwin (windows) type:
41 -1*. ssh [[username@max-fs-display.desy.de>>mailto:username@max-fs-display.desy.de||shape="rect"]]
42 -1*. enter your Science Account password
43 -1*. enter your 2FA token
44 -1*. cd /asap3/petra3/gpfs/p11/YEAR/data/**YourBeamTimeID**
45 -1. **​Graphical User Interface:**
46 -in a web browser type:
47 -1*. [[https:~~/~~/max-fs-display.desy.de:3389/>>url:https://max-fs-display.desy.de:3389/||shape="rect"]]
48 -1*. enter your Science Account credentials
49 -1*. enter your 2FA token
50 -1*. launch e.g. an XFCE session
51 -1*. open a terminal
52 -1*. cd /asap3/petra3/gpfs/p11/YEAR/data/**YourBeamTimeID**
53 -1. **Installing and using the FastX3 client:​**
54 -1*. visit [[Downloads DESYcloud>>url:https://confluence.desy.de/pages/viewpage.action?spaceKey=IS&title=Downloads+DESYcloud||shape="rect" style="text-decoration: none;"]]. Login with your DESY account.
55 -1*. click on the desycloud link next to the starnet entry. If you get to an empty page, just reload the page.
56 -1*. go to StarNet_FastX3/client/3.3 (or the highest version listed) and download the package matching your OS
57 -1*1. FastX-*-setup.exe and FastX3.msi are regular windows installer
58 -1*1. FastX-*-setup_nonroot.exe is a "portable" windows installer, e.g. can be placed on a USB stick
59 -1*1. FastX3-*.dmg is the MacOSX installer
60 -1*1. FastX3-*.rhel7.x86_64.tar.gz is a tarball for Linux, works also for Ubuntu or Debian (possibly requiring some additional packages)
61 -1*. install and launch FastX3
62 -1*. configure a new https connection (host: [[max-fs-display.desy.de>>url:http://max-fs-display.desy.de||shape="rect"]], port:3389, auth: SSH)
63 -1*. double click on the new connection
64 -1*. enter your 2FA token
65 -1*. launch e.g. an XFCE session
66 -1*. open a terminal
67 -1*. cd /asap3/petra3/gpfs/p11/YEAR/data/**YourBeamTimeID**
68 -
69 -(% style="text-align: justify;" %)
70 -Pros & cons:​
71 -
72 -* ssh: simple, convenient, but no GPU acceleration and X11 over ssh is slow. Sessions are not persistent.
73 -* browser: simple, fast,works everywhere, GPU hardware acceleration, but has some limitations (copy&paste, browser capturing key shortcuts). Supports session sharing
74 -* client: fast, works best, but requires installation of a client
75 -* browser and client offer persistent sessions: when disconnected your session continues to run without any client connected. Reconnecting to the display server gives access to the running session.
76 -
77 -Data is accessible to users who were registered participants to the experiment in Door prior to the beamtime ID being opened at the beamline. If you cannot access the data, please contact your LC or the beamline manager.
78 -
79 -(% style="text-decoration: none;" %)
80 -== Data processing ==
81 -
82 -(% style="text-align: justify;" %)
83 -The processing folders contain two folders, 'xdsapp' and 'manual'. 'Manual' contains a template for manual processing having all the correct parameters. However, to shorten the processing time and make use of the computational structure, reprocessing your data on the maxwell nodes should be done by using a script to queue the jobs in slurm:
84 -
85 -* template scripts can be found at /asap3/petra3/gpfs/common/p11/processing_scripts/
86 -** (% style="color:#000000; text-decoration:none" %)xds_users.sh For (% style="color:#ff0000; text-decoration:none" %)external users
87 -** xds_inhouse.sh For (% style="color:#ff0000" %)in-house users
88 -* (% style="color:#000000" %)differences on the scripts are on the partition (i.e. //pscpu// should be used for internal users of Photon Science and //psxcpu// for external users) and the xds version used for processing
89 -* (% style="color:#000000" %)copy the script to the folder where you run the processing
90 -* (% style="color:#000000" %)launch the script by typing //sbatch xds//(% style="color:#ff0000" %)//_//(% style="color:#ff0000; text-decoration:none" %)//name_of_the_script//(% style="color:#000000; text-decoration:none" %)//.sh// (e.g., //sbatch xds_users.sh //for external users )
91 -* (% style="color:#000000" %)the script will find a free node for your job to run fast
92 -* (% style="color:#000000" %)the xds-log you get in a file xds-job-~#~##.out.
93 -
94 -(% style="text-align: justify;" %)
95 -**Processing Serial Crystallography data** by nxds should be done via a script to queue the jobs in slurm:
96 -
97 -* a template script (nxds.sh) as well as an example of input file (nXDS.INP) can be found at /asap3/gpfs/common/p11/processing_scripts/
98 -* the partition in the script is defined psxpcu for external academic users (pscpu should be used for internal users of Photon Science)
99 -* (% style="color:#000000" %)copy the script and the nXDS.INP to the folder where you run the processing
100 -* (% style="color:#000000" %)the nXDS.INP file needs some editing to fit your data path and data collection parameters (wavelength, detector distance, oscillation...)
101 -* (% style="color:#000000" %)the processing is launch by typing sbatch nxds.sh
102 -
103 -**If manual processing through a terminal or GUI is absolutely necessary:**
104 -
105 -* allocate a node to yourself by typing in terminal: salloc ~-~-node=1 ~-~-partition=psxcpu ~-~-time=xx:xx:xx
106 -* ssh to the node allocated to you
107 -* load the modules of the needed crystallographic softwares on the node (instructions below)
108 -* HOX! terminate the allocation after usage by typing exit twice on your terminal window
109 -
110 -(% style="text-decoration: none;" %)
111 -== Crystallographic and Scientific Software Packages ==
112 -
113 -(% style="text-align: justify;" %)
114 -Software packages might be available out-of-the box as system installs or as part from the OS default repository, others are available via module functionality. A description on how to enable/use a particular software package is given on [[confluence>>https://confluence.desy.de/display/IS/Software||shape="rect" style="text-decoration: none;"]].
115 -
116 -(% style="text-align: justify;" %)
117 -Crystallographic software packages are in the [[Photon Science section>>https://confluence.desy.de/display/MXW/Photon+Science||shape="rect"]].
118 -
119 -(% style="text-align: justify;" %)
120 -You can store analysis results in scratch_cc (temporary/testing results) or processed (final results).
121 -
122 -(% style="text-align: justify;" %)
123 -To use crystallographic programs type in terminal (for example):
124 -
125 -* **module avail** #to check what programs and versions are available
126 -* **module load xray** # sets the environment for old xds and helper GUIs such as (% style="color:#000000" %)XDSAPP
127 -* (% style="color:#000000" %)**module load maxwell xds** # sets the environment for new xds
128 -* **module load ccp4/7** # sets the environment for ccp4 version 7
129 -* **module load phenix** # sets the environment for phenix
130 -
131 -(% style="text-align: justify;" %)
132 -Once the correct module is loaded, the program can be called via the command line by typing its shortcut or alias (xdsapp, phenix, albula....etc).
133 -
134 -
135 -
136 -(((
137 -
138 -)))
29 +//Accessing data//
30 +In a terminal window:
31 +ssh (% class="Object" %)[[username@desy-ps-ext.desy.de>>mailto:username@desy-ps-ext.desy.de||shape="rect"]](%%)
32 +ssh username@desy-ps-cpu
33 +Give your password when prompted
34 +Navigate to data by:
35 +cd /asap3/petra3/gpfs/p11/2020/data/beamtimeID
36 +(you can only access the data your Door account was related to during the data collections. if you did not participate to the beamtime but are part of the group and would like to access the data, please contact (whom? I'll try to figure this out)
37 +\\//List of software you can use is at~://
38 +(% class="Object" %)[[https:~~/~~/confluence.desy.de/display/IS/Photon+Science>>doc:IS.Photon Science.WebHome||shape="rect"]](%%)
39 +\\//You can store analysis results in scratch_cc (temporary/testing results) or processed (final results).//
40 +\\//To use crystallographic programs~://
41 +module avail
42 +module load xray     # sets the environment for xds and helper GUIs such as XDSAPP
43 +module load ccp4/6.4
44 +module load phenix 
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -175900747
1 +183171865
Title
... ... @@ -1,1 +1,1 @@
1 -11. Data processing
1 +10. Data processing
URL
... ... @@ -1,1 +1,1 @@
1 -https://confluence.desy.de/spaces/11/pages/175900747/11. Data processing
1 +https://confluence.desy.de/spaces/11/pages/183171865/10. Data processing