-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathumanual_start.html
More file actions
281 lines (250 loc) · 11.9 KB
/
umanual_start.html
File metadata and controls
281 lines (250 loc) · 11.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
<!DOCTYPE html>
<html>
<!--- HEAD --->
<head>
<meta charset="UTF-8">
<link href="style/main.css" rel="stylesheet">
<link href="style/umanual.css" rel="stylesheet">
<link href="icons/easydiffraction.ico" rel="shortcut icon" type="image/x-icon">
<title>easyDiffraction User Manual</title>
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-153564910-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag() {
dataLayer.push(arguments);
}
gtag('js', new Date());
gtag('config', 'UA-153564910-1');
</script>
</head>
<!--- HEAD --->
<!--- BODY --->
<body>
<!--- header with navigation --->
<header>
<section>
<nav>
<ul>
<li><a href="index.html"><img src="icons/easydiffraction.svg">easyDiffraction</a></li>
<li><a class="active" href="documentation.html"><img src="icons/book-reader.svg">Documentation</a></li>
<li><a href="contact.html"><img src="icons/envelope.svg">Contact</a></li>
</ul>
</nav>
</section>
</header>
<!--- header with navigation --->
<!--- main --->
<div class="main row">
<section>
<!--- toc area --->
<div class="toc-area">
<article>
<h2> <a href="umanual_intro.html">1. Introduction</a> </h2>
<h4> <a href="umanual_intro.html#1.1.-what-is-easydiffraction-for?">1.1. What is easyDiffraction for?</a> </h4>
<h4> <a href="umanual_intro.html#1.2.-easydiffraction-features">1.2. easyDiffraction features</a> </h4>
</article>
<article class="current">
<h2> <a href="umanual_start.html">2. Getting Started</a> </h2>
<h4> <a href="umanual_start.html#2.1.-installing-easydiffraction">2.1. Installing easyDiffraction</a> </h4>
<h4> <a href="umanual_start.html#2.2.-launching-easydiffraction">2.2. Launching easyDiffraction</a> </h4>
<h4> <a href="umanual_start.html#2.3.-uninstalling-easydiffraction">2.3. Uninstalling easyDiffraction</a> </h4>
</article>
<article>
<h2> <a href="umanual_use.html">3. How to Use</a> </h2>
<h4> <a href="umanual_use.html#3.1.-easydiffraction-user-interface">3.1. easyDiffraction user interface</a> </h4>
<h6> <a href="umanual_use.html#3.1.1.-toolbar">3.1.1. Toolbar</a> </h6>
<h6> <a href="umanual_use.html#3.1.2.-main-window">3.1.2. Main window</a> </h6>
<h6> <a href="umanual_use.html#3.1.3.-sidebar">3.1.3. Sidebar</a> </h6>
<h6> <a href="umanual_use.html#3.1.4.-settings">3.1.4. Settings</a> </h6>
<h4> <a href="umanual_use.html#3.2.-project-files">3.2. easyDiffraction project files</a> </h4>
<h6> <a href="umanual_use.html#3.2.1.-unpolarized-diffraction">3.2.1. Unpolarized diffraction</a> </h6>
<h6> <a href="umanual_use.html#3.2.2.-polarized-diffraction">3.2.2. Polarized diffraction</a> </h6>
<h4> <a href="umanual_use.html#3.3.-data-analysis-workflow">3.3. Data analysis workflow</a> </h4>
<h6> <a href="umanual_use.html#3.3.1.-home-page">3.3.1. Home page</a> </h6>
<h6> <a href="umanual_use.html#3.3.2.-project">3.3.2. Create/Open project</a> </h6>
<h6> <a href="umanual_use.html#3.3.3.-sample-model">3.3.3. Define sample model</a> </h6>
<h6> <a href="umanual_use.html#3.3.4.-experimental-data">3.3.4. Load experimental data</a> </h6>
<h6> <a href="umanual_use.html#3.3.5.-analysis">3.3.5. Perform data analysis</a> </h6>
<h6> <a href="umanual_use.html#3.3.6.-summary">3.3.6. Generate summary report</a> </h6>
</article>
</div>
<!--- toc area --->
<!--- doc area --->
<div class="doc-area">
<!--- chapter --->
<div class="doc-chapter" id="2.-getting-started">
<h1>2. Getting Started</h1>
<p>This chapter is about getting started with <b>easyDiffraction</b>.</p>
<!--- section --->
<div class="doc-section" id="2.1.-installing-easydiffraction">
<h2>2.1. Installing easyDiffraction</h2>
<p>You can download precompiled binaries of <b>easyDiffraction</b> installer for <b>macOS</b>, <b>Windows</b> and
<b>Linux (Ubuntu)</b> operating systems, or get it from the Snap Store for all major <b>Linux</b> distributions.</p>
<!--- sub-sub-section --->
<div class="doc-subsubsection">
<h4>Windows</h4>
<div class="instructions">
<ul>
<li>Visit the <a href="http://easyDiffraction.github.io/">easyDiffraction home page</a></li>
<li>Click <b>Download for Windows</b></li>
<li>Unzip the downloaded <b>easyDiffractionSetup</b> zip file</li>
<li>Double-click <b>easyDiffractionSetup.exe</b> and follow the instructions given by the installer</li>
</ul>
</div>
</div>
<!--- sub-sub-section --->
<!--- sub-sub-section --->
<div class="doc-subsubsection">
<h4>macOS</h4>
<div class="instructions">
<ul>
<li>Visit the <a href="http://easyDiffraction.github.io/">easyDiffraction home page</a></li>
<li>Click <b>Download for macOS</b></li>
<li>Unzip the downloaded <b>easyDiffractionSetup</b> zip file</li>
<li>Click <b>easyDiffractionSetup.app</b> and follow the instructions given by the installer</li>
<li>If you see the message <i>"easyDiffractionSetup.app can't be opened because it is from an
unidentified developer"</i>, do the following:</li>
<ul>
<li>In the <b>Finder</b>, locate the <b>easyDiffractionSetup.app</b></li>
<li>Control-click the app icon, then choose Open from the shortcut menu.</li>
<li>Click Open.</li>
<li>The app is saved as an exception to your security settings, and you can open it in the
future by double-clicking it just as you can any registered app. More details at
<a href="https://support.apple.com/kb/PH25088">https://support.apple.com/kb/PH25088</a></li>
</ul>
</ul>
</div>
</div>
<!--- sub-sub-section --->
<!--- sub-sub-section --->
<div class="doc-subsubsection">
<h4>Linux (Ubuntu)</h4>
<div class="instructions">
<ul>
<li>Visit the <a href="http://easyDiffraction.github.io/">easyDiffraction home page</a></li>
<li>Click <b>Download for Linux</b></li>
<li>Unzip the downloaded <b>easyDiffractionSetup</b> zip file</li>
<li>Double-click <b>easyDiffractionSetup</b> and follow the instructions given by the installer</li>
</ul>
</div>
</div>
<!--- sub-sub-section --->
<!--- sub-sub-section --->
<div class="doc-subsubsection">
<h4>Linux (all major distributions)</h4>
<div class="instructions">
<ul>
<li>Visit the <a href="https://snapcraft.io/easydiffraction">easyDiffraction latest release on Snap Store</a></li>
<li>Follow the instructions depending on your Linux distribution</li>
</ul>
</div>
</div>
<!--- sub-sub-section --->
</div>
<!--- section --->
<!--- section --->
<div class="doc-section" id="2.2.-launching-easydiffraction">
<h2>2.2. Launching easyDiffraction</h2>
<p>After <b>easyDiffraction</b> has been installed, you can run it as described below.</p>
<!--- sub-sub-section --->
<div class="doc-subsubsection">
<h4>Windows</h4>
<div class="instructions">
<ul>
<li>Double-click the <b>easyDiffraction</b> icon on the <b>Desktop</b> or</li>
<li>Select <b>easyDiffraction</b> from the <b>Start Menu</b> or</li>
<li>Navigate to the installation folder with <b>Windows Explorer</b> and double-click <b>easyDiffraction.exe</b></li>
</ul>
</div>
</div>
<!--- sub-sub-section --->
<!--- sub-sub-section --->
<div class="doc-subsubsection">
<h4>macOS</h4>
<div class="instructions">
<ul>
<li>Double-click the <b>easyDiffraction</b> icon on the <b>Launchpad</b> or</li>
<li>Navigate to the installation folder with <b>Finder</b> and double-click <b>easyDiffraction.app</b></li>
</ul>
</div>
</div>
<!--- sub-sub-section --->
<!--- sub-sub-section --->
<div class="doc-subsubsection">
<h4>Linux</h4>
<div class="instructions">
<ul>
<li>Double-click the <b>easyDiffraction</b> icon on the <b>Desktop</b> or</li>
<li>Navigate to the installation folder with file manager and double-click <b>easyDiffraction</b></li>
</ul>
</div>
</div>
<!--- sub-sub-section --->
</div>
<!--- section --->
<!--- section --->
<div class="doc-section" id="2.3.-uninstalling-easydiffraction">
<h2>2.3. Uninstalling easyDiffraction</h2>
<p>You can uninstall <b>easyDiffraction</b> any time as described below.</p>
<!--- sub-sub-section --->
<div class="doc-subsubsection">
<h4>Windows</h4>
<div class="instructions">
<ul>
<li>Open <b>Windows Explorer</b> and navigate to the folder where <b>easyDiffraction</b> is installed</li>
<li>Double-click <b>easyDiffractionUninstaller.exe</b> and follow the instructions given by the uninstaller</li>
</ul>
</div>
</div>
<!--- sub-sub-section --->
<!--- sub-sub-section --->
<div class="doc-subsubsection">
<h4>macOS</h4>
<div class="instructions">
<ul>
<li>Open <b>Finder</b> and navigate to the folder where <b>easyDiffraction</b> is installed</li>
<li>Click <b>easyDiffractionUninstaller.app</b> and follow the instructions given by the uninstaller</li>
</ul>
</div>
</div>
<!--- sub-sub-section --->
<!--- sub-sub-section --->
<div class="doc-subsubsection">
<h4>Linux</h4>
<div class="instructions">
<ul>
<li>Open file manager and navigate to the folder where <b>easyDiffraction</b> is installed</li>
<li>Click <b>easyDiffractionUninstaller</b> and follow the instructions given by the uninstaller</li>
</ul>
</div>
</div>
<!--- sub-sub-section --->
</div>
<!--- section --->
</div>
<!--- chapter --->
</div>
<!--- column --->
</section>
</div>
<!--- doc area --->
<!--- main --->
<!--- footer with navigation --->
<footer>
<section>
<nav>
<ul>
<li>2020 <a href="index.html">easyDiffraction.org</a></li>
<li>•</li>
<li><a href="https://github.com/easyDiffraction/easyDiffraction"><img src="icons/github.svg">GitHub</a></li>
<li>•</li>
<li>Designed by <a href="http://sazonov.org">Andrew Sazonov</a></li>
</ul>
</nav>
</section>
</footer>
<!--- footer with navigation --->
<!--- BODY --->
</body>
</html>