| 1 |
BioXTAS RAW |
| 2 |
=========== |
| 3 |
|
| 4 |
What is BioXTAS RAW? |
| 5 |
-------------------- |
| 6 |
|
| 7 |
BioXTAS RAW is a GUI based, free, open-source Python program for reduction and analysis |
| 8 |
of small-angle X-ray solution scattering (SAXS) data. The software is designed for biological |
| 9 |
SAXS data. It is available on Windows, macOS (and OS X), and Linux. It provides an |
| 10 |
alternative to closed source programs such as Primus and Scatter for primary data analysis. |
| 11 |
Because it can calibrate, mask, and integrate images it also provides an alternative to |
| 12 |
synchrotron beamline pipelines that scientists can install on their own computers and use |
| 13 |
both at home and at the beamline. |
| 14 |
|
| 15 |
:ref:`Find out how to get it! <install>` |
| 16 |
|
| 17 |
Features |
| 18 |
-------- |
| 19 |
|
| 20 |
* Analysis of radius of gyration (|Rg|) and I(0) via Guinier fit. |
| 21 |
* Analysis of molecular weight via I(0) comparison to standards, absolute |
| 22 |
calibration, correlation volume (V\ :sub:`c`), corrected Porod volume |
| 23 |
(V\ :sub:`p`), the ATSAS Shape&Size and the ATSAS Bayesian methods. |
| 24 |
* Calculation of inverse Fourier transforms (IFTs) via GNOM, DENSS (DIFT) and a Bayesian |
| 25 |
indirect Fourier transform (BIFT). |
| 26 |
* Calculation of envelopes (dummy atom models) using DAMMIF, DAMMIN, DAMAVER, and DAMCLUST. |
| 27 |
* Calculation of electron density using the DENSS algorithm |
| 28 |
* Calculation and fitting of theoretical profiles to experimental data using CRYSOL. |
| 29 |
* Easy processing of in-line chromatography coupled SAXS data, including size-exclusions |
| 30 |
coupled SAXS (SEC-SAXS) data. |
| 31 |
* Deconvolution of SAXS data using singular value decomposition (SVD) and |
| 32 |
evolving factor analysis (EFA), and regularized alternating least squares |
| 33 |
(REGALS). |
| 34 |
* Standard data operations such as averaging, subtraction, merging, and rebinning. |
| 35 |
* Creation and plotting of 1D scattering profiles from 2D detector images, including |
| 36 |
Pilatus, CBF, Eiger, and more than 20 other types of images. |
| 37 |
|
| 38 |
|
| 39 |
What is the RAW API? |
| 40 |
--------------------- |
| 41 |
|
| 42 |
You can also :ref:`install BioXTAS RAW as a python package <api>` without the |
| 43 |
GUI. This lets you import RAW directly into your python scripts and use the |
| 44 |
API to call any of the functions in RAW. This is great for creating custom |
| 45 |
processing scripts, either for unusual datasets that aren't handled in the |
| 46 |
GUI, or to ensure reproducibility in your analysis. It can also be used |
| 47 |
as the basis for an open-source automated SAXS data processing pipeline at |
| 48 |
a beamline or homesource. |
| 49 |
|
| 50 |
|
| 51 |
Development |
| 52 |
----------- |
| 53 |
|
| 54 |
RAW is currently developed by Jesse Hopkins, Director of `the BioCAT beamline |
| 55 |
<https://www.bio.aps.anl.gov/>`_ at the APS. Techniques developed by other |
| 56 |
scientists are frequently incorporated into RAW in order to make these methods |
| 57 |
available to a wide audience. The development version of the source code is |
| 58 |
available on github: |
| 59 |
|
| 60 |
`https://github.com/jbhopkins/bioxtasraw <https://github.com/jbhopkins/bioxtasraw>`_ |
| 61 |
|
| 62 |
|
| 63 |
History and Usage |
| 64 |
----------------- |
| 65 |
RAW was first developed in 2008 by Soren Skou as part of the biological x-ray total analysis |
| 66 |
system (BioXTAS) project. Since then it has been extensively developed, with recent |
| 67 |
work being done by Jesse Hopkins. |
| 68 |
|
| 69 |
RAW is used at various beamlines, including: |
| 70 |
|
| 71 |
* `BioCAT (18-ID) <https://www.bio.aps.anl.gov/>`_ at the APS |
| 72 |
* `MacCHESS ID7A BioSAXS <https://www.chess.cornell.edu/index.php/macchess/biosaxs>`_ |
| 73 |
at CHESS |
| 74 |
* `LiX <https://www.bnl.gov/nsls2/beamlines/beamline.php?r=16-ID>`_ at NSLS II |
| 75 |
* `SIBYLS <https://bl1231.als.lbl.gov/htsaxs>`_ at ALS |
| 76 |
* `BIO-SANS at ORNL <https://neutrons.ornl.gov/biosans>`_ |
| 77 |
* BL19U2 at SSRF |
| 78 |
|
| 79 |
Xenocs distributes RAW with some of its homesources, and RAW is used at |
| 80 |
various other homesources around the world. |
| 81 |
|
| 82 |
Do you use RAW? :ref:`Let us know! <contactus>` |
| 83 |
|
| 84 |
|
| 85 |
Licensing |
| 86 |
----------------- |
| 87 |
RAW source code is released under a GPLv3 license. Both the source code and the |
| 88 |
prebuilt versions of RAW are free for anyone to download and use. |
| 89 |
|
| 90 |
.. toctree:: |
| 91 |
:hidden: |
| 92 |
:maxdepth: 2 |
| 93 |
|
| 94 |
install |
| 95 |
help |
| 96 |
tutorial |
| 97 |
saxs_tutorial |
| 98 |
videos |
| 99 |
cite_raw |
| 100 |
api |
| 101 |
manual |
| 102 |
changes |
| 103 |
|
| 104 |
|
| 105 |
.. |Rg| replace:: R\ :sub:`g` |