Debian Codegraph @

docs/source/manual/Installing_RAW.rst

raw
1 Installing RAW
2 ==============
3
4 **WARNING:** The manual is current several versions out of date. While it may
5 still be useful for some users, please refer to the tutorial for the most
6 up-to-date information.
7
8 This chapter provides an overview of how to install RAW on Windows, Linux and Macintosh. Detailed installation guides for each system are available separately. It covers:
9
10 * Licensing
11
12 * System requirements
13
14 * Installing from source code.
15
16 * Installing from pre-compiled binaries.
17
18 * Obtaining the newest version of RAW
19
20
21 Licensing
22 ---------
23
24 RAW is open source software, which means the source code is freely available and
25 can be modified/extended as the experienced users sees fit. RAW is available under
26 the GPL V3 license which means that if a modified version of RAW, or any software
27 that uses any of the code available in RAW, is made available to users, then the
28 full source code must also be made available. For a full description of the GPL
29 licensing terms, see the file gpl-3.0.txt included with the RAW source code, or visit
30 `https://www.gnu.org/licenses/gpl-3.0.html <https://www.gnu.org/licenses/gpl-3.0.html>`_
31
32
33 System requirements
34 -------------------
35
36 The faster the machine the better the experience.
37
38 *Minimum Requirements*
39
40 1.6 GHz 32 bit (x86) Computer
41
42 1 GB of memory
43
44 1024x768 resolution display
45
46 Windows 7 or newer, Mac OSX 10.9 or newer, Linux
47
48 Note: The newest version of RAW may run on Windows XP or Vista and OS X 10.4+,
49 but it has not been tested by the developers on these older systems.
50
51
52 *Optimal Requirements*
53
54 2.5+ GHz 32/64 bit (x86) Dual/Quad Core Computer
55
56 2+ GB of memory
57
58 1280x1024+ resolution display
59
60 Windows 7 or newer, Mac OSX 10.9 or newer, Linux
61
62
63 Installing RAW from pre-compiled binaries
64 -----------------------------------------
65
66 A prebuilt installer is available for RAW for Windows and Mac. We recommend that most
67 users install the prebuilt versions. The windows installer has been tested on Windows 7,
68 8.1, and 10. It may also work for older versions. The Mac installer has been tested on
69 macOS/OS X 10.9 - 10.12. It may also work for older versions.
70
71
72 Instructions for prebuilt installers are available here:
73
74 * :ref:`Windows <winprebuilt>`
75
76 * :ref:`Mac <macprebuilt>`
77
78
79 Installing RAW from source code
80 -------------------------------
81
82 Installing RAW from source code takes more work but has the advantage that
83 the newest version can always be downloaded and quickly installed once the
84 necessary tools have been installed. Installing a pre-compiled version of
85 RAW is easier, but compiled versions are not updated as often as the source
86 code due to the time consuming process of making a compiled executable.
87 Compiled versions may also only be available for certain platforms.
88
89
90 Instructions for install RAW from source are available for
91
92 * :ref:`Windows <winsource>`
93
94 * :ref:`Mac <macsource>`
95
96 * :ref:`Linux <lnxsource>`
97
98
99 **NOTE:** As of writing, the RAW is **only** compatible with Python version 2.7
100 and not the newer 3.x versions.
101
102
103 Obtaining the newest version of RAW
104 -----------------------------------
105
106 The newest version of RAW can always be found on Sourceforge. The released source code and compiled binaries can be downloaded at:
107
108 `https://sourceforge.net/projects/bioxtasraw/files/ <https://sourceforge.net/projects/bioxtasraw/files/>`_
109
110
111 To obtain the very latest unreleased version (that might or might not be stable) go to:
112 `https://sourceforge.net/p/bioxtasraw/code/HEAD/tree/trunk/src/ <https://sourceforge.net/p/bioxtasraw/code/HEAD/tree/trunk/src/>`_
113
114 And click “Download Snapshot" near the top of the screen. Unpack the content into a folder
115 and run RAW.py as usual.
116
117
118 **NOTE:** When installing new source code on top of old it is important to delete the old source code, including the compiled C libraries with the extensions .so, .pyc, and .pyd, otherwise RAW could be loading old code and become unstable.
119
120
121 Integrating ATSAS with RAW
122 ---------------------------
123
124 .. _atsas:
125
126 RAW allows you to do analysis with some of the programs from the ATSAS
127 package directly from RAW. Currently, you can use GNOM, DAMMIF, and AMBIMETER
128 in RAW. This requires a separate ATSAS installation, as the RAW developers
129 are not allowed to distribute the ATSAS package with RAW.
130
131
132 Installing the ATSAS package
133 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
134
135 The ATSAS package is available from EMBL, and can be downloaded here:
136
137 `https://github.com/biosaxs-com/atsas-community <https://github.com/biosaxs-com/atsas-community>`_
138
139 Installation instructions are available here:
140
141 `https://biosaxs-com.github.io/atsas/4.0.0/install/ <https://biosaxs-com.github.io/atsas/4.0.0/install/>`_
142
143 We recommend installing the packages in the default installation location.
144
145 To use all of the programs through RAW, you need ATSAS version 2.7.1 or greater.
146 GNOM and DAMMIF may work for earlier versions of the ATSAS package, but the RAW
147 developers have not tested this.
148
149
150 Locating the ATSAS package for RAW
151 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
152
153 RAW will attempt to automatically locate the ATSAS package when you start up RAW
154 (and when you load a configuration file). It may fail to do this, in which case
155 you will need to set the location of the ATSAS programs manually. To do this:
156
157 * Open the “ATSAS” section of the Options window.
158
159 * Uncheck the “Automatically find the ATSAS bin location”
160
161 * Either by typing the path or using the “Select Directory” button,
162 select the “bin” folder inside the main ATSAS folder. This folder should
163 have a dammif executable inside of it.
164
165
166 Running without compiled extensions
167 ------------------------------------
168
169 RAW compiles certain extensions that are written in C++ in order to maximize
170 the speed of the program. These extensions are involved in the following tasks:
171 Making polygon masks, integrating images into scattering profiles, and carrying
172 out the BIFT analysis. All of these extensions are also available in native
173 python code, but run much more slowly. If RAW is unable to compile these extensions,
174 a warning message will display when the program is started.
175
176 While RAW is able to run without the extensions compiled, it will significantly
177 impact performance of the listed tasks. We recommend troubleshooting the RAW
178 installation, or reinstalling RAW to get these to compile. The RAW installation
179 guides contain detailed install instructions and some solutions to common problems
180 with the installation. Please refer to those for more details.