Project

General

Profile

Administration Tools Guide » History » Version 3

Sargis Dallakyan, 11/25/2019 05:51 PM

1 1 Amber Herold
h1. Administration Tools Guide
2
3
After a new installation, you will have to input Groups,Users and Instrument to the database you have just created. Applications will need to be imported, too. These tasks can be performed through the web-based Administration Tools.
4
5
6
7
h2.  Recommandation for setup at a new institute
8
9
10
11
12
h2. First user : administrator
13
14
15
16
The user named "administrator" is a special user in Leginon. Once the setting preferences in a node that shares the same class and alias are defined by the administrator, all newly created users get these settings when they launch the node until they make changes themselves. This allows a faster setup per database (institute) for the beginners. Therefore, the first user should be named as "administrator" and it should be used normally to ensure the stability of these default preferences.
17
18
19
20
21
22
h2. Additional users :
23
24
25
26
A Leginon user set in the adminstration tool defines his/her own preferences once changed from the "adminstrator" user default above. It is also not related to the computer login user. Therefore, it is is necessary to go through the steps outlined in "<link linkend="admin_adduser">Set up for a new regular user</link>" section.
27
28
29
30
31
32
33
34
h2.  Steps involved in the installation
35
36
37
38
See <link linkend="Inst_Adm">Installation Troubleshooting</link> and  "Leginon Bulletin Board":http://emg.nysbc.org/bb/viewforum.php?f=2  searching for "admin" if you run into problems.
39
40
41
42
h2. Go to administration page
43
44
45 2 Neil Voss
Open a web browser. Go to http://localhost/myamiweb/admin.php
46 1 Amber Herold
47
48
49
50
51
h2. Add a Group
52
53
54
Groups are used to associate users together. At the moment, Leginon does not use the group association for anything.
55
56
57 2 Neil Voss
*  At http://localhost/myamiweb/admin.php, click on Groups.
58 1 Amber Herold
59
60
*  Add a "name" (required) for the group.
61
62
63
*  Optionally enter a full name for the group.
64
65
66
*  Click Save.
67
68
69
70
71
72
73
74
h2.  Add Adminstrator User
75
76
77
78 2 Neil Voss
*  At http://localhost/myamiweb/admin.php, click on Users.
79 1 Amber Herold
80
81
*  Add "administrator" as the user.
82
83
84
*  Enter a full name as "administrator". This name should be typed exactly as it is (case-sensitive).
85
86
87
*  Add this user to a previously created group.
88
89
90
*  Click Save.
91
92
93
94
95
96
97
98
h2.  Add your mircoscope as an TEM instrument
99
100
101
102
*  Click on Instruments.
103
104
105
*  Add a "name" (required and <link linkend="instrument_names">not arbitrary</link>--FEI tecnai/polara/spirit series are all called "Tecnai") for the microscope. Follow the cases! (a unix requirement)
106
107
108
*  Enter the hostname of the microscope. Do not captalize the characters!!! (a Window's requirement)
109
110
111
*  Select instrument type TEM.
112
113
114
*  Click Save.
115
116
117
118
119
120
121
122
h2.  Add your CCD camera as an CCDCamera instrument
123
124
125
126
*  Click on Instruments.
127
128
129
*  Add a "name" for the camera (required and <link linkend="instrument_names">not arbitrary</link>--Gatan cameras are all called "Gatan"/Tietz cameras all have different names). Follow the cases! (a unix requirement)
130
131
132
See the section on <link linkend="instrument_names">Instrument Tool</link> for more details.
133
134
135
*  Enter the hostname of the microscope. Do not captalize the characters!!! (a Window's requirement)
136
137
138
*  Select instrument type CCDCamera.
139
140
141
*  Click Save.
142
143
144
145
146
147
148
149
h2.  Load the default settings of Legion nodes
150
151
152
153
*  Click on Default Settings.
154
155
156
*  Click on Load.
157
158
159
160
161
162
163
164
h2.  Import Applications
165
166
167
168
*  Click on Applications.
169
170
171
!http://emg.nysbc.org/software/leginon/images/images/application_on.png!
172
173
174
* Enter the name of the Leginon application XML file. These are files in a subdirectory of your leginon installation called "applications" starting from Leginon v1.3.
175
176
177
178
179
180
<blockquote>
181
182
The most commonly used Leginon applications are included as part of the Leginon download. These XML files are in subdirectory of your Leginon download and installation called "applications". The XML files should be imported either using the web based application import tool. Each application includes "(1.5)" in its name to indicate that it will work with this new version of Leginon. The applications that carry the older version name are compatible with the older Leginon.
183
184
To find Leginon installation path on Linux:<pre> >start-leginon.py -v</pre>
185
186
187
On Windows, You should find a shortcut to your Leginon installation folder in the "Start Menu/All Programs/Leginon". If not, it is likely
188
189
<pre>C:\Python25\Lib\site-packages\Leginon\</pre>
190
</blockquote>
191
192
193
* !http://emg.nysbc.org/software/leginon/images/images/admin_apptable.png!
194
195
196
*  Select the name of the "To" Host the application will be imported to.
197
198
199
*  Click Import.
200
201
202
203
204
205
206
207
h2.  Proceed to First Leginon Test Run Chapter
208
209
210
<link linkend="runleg_chapter">Leginon test runs</link> test for tem/ccd controls and network communications. The rest of this chapter is for references.
211
212
213
214
215
216
217
218
h2.  Set up for a new regular user
219
220
221
222
A Leginon user set in the adminstration tool defines his/her own preferences once changed from the "adminstrator" user default above. It is also not related to the computer login user. Therefore, it is is necessary to go through the following steps to set up an existing computer user as a new Leginon user:
223
224
225
226
h2.  Add a User From Administration web page
227
228
229
230 2 Neil Voss
*  Open a web browser. Go to http://localhost/myamiweb/admin.php
231 1 Amber Herold
232
233
*  Click on Users.
234
235
236
*  Add a "name" (required) for the user. (This is like a one-word username that people use to log into a computer).
237
238
239
*  Optionally enter a full name for the user. (required)
240
241
242
*  Add this user to a previously created group. Or, add a new group for this user. (required)
243
244
245
*  Click Save.
246
247
248
249
250
!http://emg.nysbc.org/software/leginon/images/images/user_on.png!
251
252
253
!http://emg.nysbc.org/software/leginon/images/images/admin_usertable.png!
254
255
256
257
258
259
h2. Get a copy of the configuration files
260
261
262
Copy <link linkend="leginon_cfg">leginon.cfg</link> and <link linkend="sinedon_cfg">sinedon.cfg</link> (if not set globally for all users) from an existing user to the home directory of the new user.
263
264
265
266
267
268
h2. Modify leginon.cfg
269
270
271
Modify the [user] "Fullname" field in <command moreinfo="none">leginon.cfg</command> to correspond the "full name" field in the Leginon Administration User Tools.
272
273
274
275
276
277
278
279
h2.  More about Groups
280
281
282
Groups are used to associate users together. At the moment, Leginon does not use the group association for anything.
283
284
285
286
h2. Add/Edit a Group
287
288
289
290 2 Neil Voss
*  Open a web browser. Go to http://localhost/myamiweb/admin.php
291 1 Amber Herold
292
293
*  Click on Groups.
294
295
296
*  Add a "name" (required) for the group.
297
298
299
*  Optionally enter a full name for the group.
300
301
302
*  Click Save.
303
304
305
306
307
308
309
310
h2.  Remove a Group
311
312
313
314 2 Neil Voss
*  Open a web browser. Go to http://localhost/myamiweb/admin.php
315 1 Amber Herold
316
317
*  Click on Groups.
318
319
320
*  Highlight a group name from the list of created Groups.
321
322
323
*  Click Remove.
324
325
326
327
328
!http://emg.nysbc.org/software/leginon/images/images/group1_on.png!
329
330
331
!http://emg.nysbc.org/software/leginon/images/images/admin_grouptable.png!
332
333
334
335
336
337
338
339
h2.  More about Instruments
340
341
342
This is used to add details about the microscope and CCD Leginon will be connected to. More than one instrument can be added with different configurations. The "import" function is useful if the instrument information has been stored on different machines in different Leginon databases.
343
344
345
346
h2.  Valid Instrument Names
347
348
349
TEM names:
350
*  Tecnai
351
352
353
354
Camera names:
355
*  Gatan
356
357
358
*  Tietz SCX
359
360
361
*  Tietz PXL
362
363
364
*  Tietz PVCam
365
366
367
*  Tietz PVCam
368
369
370
*  Tietz FastScan
371
372
373
*  Tietz FastScan Firewire
374
375
376
*  Tietz FC415
377
378
379
*  Tietz Simulation
380
381
382
383
384
385
386
387
h2.  Add/Edit an Instrument
388
389
390
391 2 Neil Voss
*  Open a web browser. Go to http://localhost/myamiweb/admin.php
392 1 Amber Herold
393
394
*  Click on Instruments.
395
396
397
*  Add a "name" (required and not arbitrary, see the above section) for the microscope or camera.
398
399
400
*  Enter the hostname of the microscope. The domain suffix need not be entered if all machines are under the same hostname.
401
402
403
*  Select instrument type.
404
405
406
*  Click Save.
407
408
409
410
411
412
413
414
h2.  Remove an Instrument
415
416
417
418 2 Neil Voss
*  Open a web browser. Go to http://localhost/myamiweb/admin.php
419 1 Amber Herold
420
421
*  Click on Instruments.
422
423
424
*  Highlight an instrument name from the list of created instruments.
425
426
427
*  Click Remove.
428
429
430
431
432
433
434
435
h2.  Import an Instrument Pair
436
437
438
439 2 Neil Voss
*  Open a web browser. Go to http://localhost/myamiweb/admin.php
440 1 Amber Herold
441
442
*  Click on Instruments.
443
444
445
*  Select a From Host and the name of the Instruments.
446
447
448
*  Click Import.
449
450
451
452
453
!http://emg.nysbc.org/software/leginon/images/images/tem_tecnai_icon_on.png!
454
455
456
!http://emg.nysbc.org/software/leginon/images/images/admin_instrutable.png!
457
458
459
460
461
462
463
464
h2.  Applications
465
466
467
Applications define how nodes are linked together in order to form a specialized Leginon application or program. Because Leginon uses a nodal or modular archetecture, multiple applications can be created by linking together nodes in different fashions suitable for the current experiment. Several default Leginon applications are distributed with the release. This section enables the Leginon user to import and export applications.
468
469
470
471
h2.  Import Applications online
472
473
474
475 2 Neil Voss
*  Open a web browser. Go to http://localhost/myamiweb/admin.php
476 1 Amber Herold
477
478
*  Click on Applications.
479
480
481
!http://emg.nysbc.org/software/leginon/images/images/application_on.png!
482
483
484
*  Enter the name of the Leginon application XML file. These are files in a subdirectory of your leginon installation called "applications" starting from Leginon v1.3.
485
486
487
!http://emg.nysbc.org/software/leginon/images/images/admin_apptable.png!
488
489
490
*  Select the name of the "To" Host the application will be imported to.
491
492
493
*  Click Import.
494
495
496
497
498
499
500
501
h2. Export Applications online
502
503
504
505
506
h2.  to another Host
507
508
509
510
511 2 Neil Voss
*  Open a web browser. Go to http://localhost/myamiweb/admin.php
512 1 Amber Herold
513
514
*  Click on Applications.
515
516
517
*  Select the name of the "From" Host.
518
519
520
*  Select the name of the Leginon application.
521
522
523
*  Select the "To" Host.
524
525
526
*  Click "Export"
527
528
529
530
531
532
533
534
535
h2.  to a Leginon application XML file
536
537
538
539
540 2 Neil Voss
*  Open a web browser. Go to http://localhost/myamiweb/admin.php
541 1 Amber Herold
542
543
*  Click on Applications.
544
545
546
*  Select the name of the "From" Host.
547
548
549
*  Select the name of the Leginon application.
550
551
552
*  Keep "Export to XML format" enabled.
553
554
555
*  Enable "Save as"
556
557
558
*  Click Export
559
560
561
562
563
564
565
566
567
h2.  to the screen in XML format
568
569
570
571
572 2 Neil Voss
*  Open a web browser. Go to http://localhost/myamiweb/admin.php
573 1 Amber Herold
574
575
*  Click on Applications.
576
577
578
*  Select the name of the "From" Host.
579
580
581
*  Select the name of the Leginon application.
582
583
584
*  Keep "Export to XML format" enabled.
585
586
587
*  Click Export
588
589
590
591
592
593
594
595
596
h2.  to the screen in "easy-to-read" format
597
598
599
600
601 2 Neil Voss
*  Open a web browser. Go to http://localhost/myamiweb/admin.php
602 1 Amber Herold
603
604
*  Click on Applications.
605
606
607
*  Select the name of the "From" Host.
608
609
610
*  Select the name of the Leginon application.
611
612
613
*  Select View
614
615
616
*  Click Export
617
618
619
620
621
622
It should contain tables of Application Data, NodeSpec Data, and likely BindingSpec Data.
623
624
625
626
627
628
629
630
631
632
h2.  Calibrations
633
634
635
636
Good calibrations are absolutely essential to running Leginon. They can also be very time consuming. As a way of rudimentarily starting up without calibrating the current instrument specifically or perhaps to revert to a previously saved calibration, this import/export calibration tool can be quite useful.
637
638
639
640
h2.  Import Calibrations
641
642
643
644 2 Neil Voss
*  Open a web browser. Go to http://localhost/myamiweb/admin.php
645 1 Amber Herold
646
647
*  Click on Calibrations.
648
649
650
*  Enter the name of the Leginon calibration XML file.
651
652
653
*  Select the name of the To Host the calibrations will be imported to.
654
655
656
*  Click Import.
657
658
659
660
661
662
663
664
h2. Export Calibrations
665
666
667
668
669
h2.  to another Host
670
671
672
673
674 2 Neil Voss
*  Open a web browser. Go to http://localhost/myamiweb/admin.php
675 1 Amber Herold
676
677
*  Click on Calibrations.
678
679
680
*  Select the name of the "From" Host and desired Instrument.
681
682
683
*  Select the names of the calibrations to export.
684
685
686
*  Select the "To" Host and desired Instrument.
687
688
689
*  Click Export
690
691
692
693
694
695
696
697
698
h2.  to a Leginon application XML file
699
700
701
702
703 2 Neil Voss
*  Open a web browser. Go to http://localhost/myamiweb/admin.php
704 1 Amber Herold
705
706
*  Click on Calibrations.
707
708
709
*  Select the name of the "From" Host and desired Instrument.
710
711
712
*  Select the names of the calibrations to export.
713
714
715
*  Keep "Export to XML format" enabled.
716
717
718
*  Enable "Save as"
719
720
721
*  Click Export
722
723
724
725
726
727
728
729
730
h2.  to the screen in XML format
731
732
733
734
735 2 Neil Voss
*  Open a web browser. Go to http://localhost/myamiweb/admin.php
736 1 Amber Herold
737
738
*  Click on Calibrations.
739
740
741
*  Select the name of the "From" Host and desired Instrument.
742
743
744
*  Select the names of the calibrations to export.
745
746
747
*  Keep "Export to XML format" enabled.
748
749
750
*  Click Export
751
752
753
754
755
756
757
758
759
h2.  to the screen in "easy-to-read" format
760
761
762
763
764 2 Neil Voss
*  Open a web browser. Go to http://localhost/myamiweb/admin.php
765 1 Amber Herold
766
767
*  Click on Calibrations.
768
769
770
*  Select the name of the "From" Host and desired Instrument.
771
772
773
*  Select the names of the calibrations to export.
774
775
776
*  Select View
777
778
779
*  Click Export
780
781
782
783
784
785
!http://emg.nysbc.org/software/leginon/images/images/calibration_on.png!
786
787
788
!http://emg.nysbc.org/software/leginon/images/images/admin_caltable.png!
789
790
791
792
793
794
795
796
797
798
h2.  Goniometer
799
800
801
The goniometer movement must be modeled for finer movements. Leginon calibrates this movement through the Gon Modeler node. Through this feature, the models for these movements can be graphically seen.
802
803
804
805
h2.  View the Goniometer Model
806
807
808
809
*  Open a web browser. Go to http://yourhost/dbem/admin.php
810
811
812
*  Click on Goniometer
813
814
815
*  Select a model to display.
816
817
818
*  Click view.
819
820
821
822
823
824
!http://emg.nysbc.org/software/leginon/images/images/goniometer_on.png!
825
826
827
!http://emg.nysbc.org/software/leginon/images/images/admin_gontable.png!