Project

General

Profile

Administration Tools » History » Version 2

Amber Herold, 04/14/2010 03:56 PM

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