Project

General

Profile

Administration Tools » History » Version 1

Amber Herold, 04/12/2010 05:20 PM

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