Debian Codegraph @

docs/source/tutorial/introduction.rst

raw
1 Introduction
2 ------------
3 .. _raw_tutorial:
4
5 Overview
6 ^^^^^^^^^^^^^^^^^^
7 This tutorial covers SAXS data processing with RAW. You will learn how to:
8
9 * Process images into scattering profiles
10 * Average, subtract and save scattering profiles
11 * Find |Rg| and I(0) by Guinier analysis
12 * Find molecular weight by six different methods
13 * Do Kratky analysis and dimensionless Kratky analysis
14 * Compare scattering profiles using residuals, ratios, and statistical tests
15 * Load and process SEC-SAXS data
16 * Carry out singular value decomposition (SVD) and evolving factor analysis (EFA)
17 to evaluate and deconvolve SEC-SAXS data
18 * Carry out regularized alternating least squares (REGALS) analysis to
19 deconvolve SAXS data.
20 * Do baseline correction on SEC-SAXS data
21 * Merge SAXS/WAXS data from two detectors
22 * Carry out Pair-distance distribution analysis (BIFT, DIFT and GNOM)
23 * Evaluate ambiguity of 3D shape reconstructions (AMBIMETER)
24 * 3D reconstructions with bead models (DAMMIF/N and DAMAVER)
25 * 3D reconstructions with electron density (DENSS)
26 * Align 3D reconstructions with high resolution models (DENSS and CIFSUP)
27 * Calculate theoretical scattering profiles from models and fit the
28 theoretical scattering against experimental data (CRYSOL and PDB2SAS)
29 * Save your analysis information and plots
30 * Calibrate RAW for integrating images
31 * Mask images for integration
32 * Set up normalization and save processing settings
33 * Set absolute scaling in RAW using water and glassy carbon
34 * Set a molecular weight standard in RAW
35
36 :ref:`Section 1 <section1>` covers basic processing with RAW, and
37 :ref:`Section 2 <section2>` covers advanced processing with RAW.
38 :ref:`Section 3 <section4>` covers saving plots and plot data and opening
39 data in other programs.
40 :ref:`Section 4 <section3>` covers how to set up RAW for integrating images for
41 those who do not already have a configuration file.
42
43
44 This tutorial is focused on how to use RAW, it is not necessarily a tutorial
45 on best practices for SAXS data processing. The :ref:`SAXS tutorial <saxs_tutorial>`
46 covers some basic processing and analysis best practices.
47
48 Requirements
49 ^^^^^^^^^^^^
50 * BioXTAS RAW >= v2.3.0 (most recent is best).
51
52 * :ref:`Install instructions <install>`
53
54 .. _tutorialdata:
55
56 * Tutorial data.
57
58 * Available from:
59 `https://sourceforge.net/projects/bioxtasraw/files/?source=navbar
60 <https://sourceforge.net/projects/bioxtasraw/files/?source=navbar>`_
61
62 .. _atsas:
63
64 * ATSAS programs, >= v3.1.1 (for parts of :ref:`Section 2 <section2>` of
65 the tutorial).
66
67 * Download and installation instructions are available from:
68 `https://github.com/biosaxs-com/atsas-community <https://github.com/biosaxs-com/atsas-community>`_
69
70 * Requires a free registration for academic users. Proprietary users must pay to use.
71
72 Other useful materials
73 ^^^^^^^^^^^^^^^^^^^^^^^
74 #. `Video lectures from BioCAT's Everything BioSAXS workshops,
75 <https://www.youtube.com/playlist?list=PLbPNI520xTsEYbJk8V0BNQ461xnG6tpRW>`_
76 which can help you learn more about best practices for SAXS data processing.
77
78 #. Most tutorial sections have a linked video tutorial. A full playlist of the
79 videos is available here:
80
81 .. raw:: html
82
83 <style>.embed-container { position: relative; padding-bottom: 56.25%; height: 0; overflow: hidden; max-width: 100%; } .embed-container iframe, .embed-container object, .embed-container embed { position: absolute; top: 0; left: 0; width: 100%; height: 100%; }</style><div class='embed-container'><iframe src='https://www.youtube.com/embed/videoseries?list=PLm39Taum4df4alFnacOOr1RWgylwiTWED' frameborder='0' allowfullscreen></iframe></div>
84
85 #. ATSAS resources:
86
87 * Manuals: `https://biosaxs-com.github.io/atsas/4.0.0/manuals/ <https://biosaxs-com.github.io/atsas/4.0.0/manuals/>`_
88 * User forum: `https://github.com/biosaxs-com/atsas-community/discussions <https://github.com/biosaxs-com/atsas-community/discussions>`_
89
90 #. Electron density (DENSS) resources available at `DENSS.org <denss.org>`_
91
92 * Particularly useful is the section on `visualizing the results and aligning with known structures <https://www.tdgrant.com/denss/tips/>`_.
93
94 Notes
95 ^^^^^^
96 If you are only interested in using RAW to process data, and are not interested
97 in how to set up RAW to calibrate your data, you do not need to look at
98 :ref:`Section 4 <section3>`.
99
100
101 RAW depends on user feedback to get better. If you have questions, find bugs,
102 or think a part of this tutorial is unclear, :ref:`please let the developers know.
103 <contactus>`
104
105
106 You can find additional developer contact information on the RAW website:
107 `https://sourceforge.net/projects/bioxtasraw/ <https://sourceforge.net/projects/bioxtasraw/>`_
108
109
110 .. |Rg| replace:: R\ :sub:`g`