Project

General

Profile

Installation on the microscope computer 21 » History » Version 2

Neil Voss, 06/18/2015 12:44 PM

1 1 Anchi Cheng
h1. Installation on the microscope computer 2.1
2
3
4
h1. Installation on the microscope computer
5
6
[[Installation on the microscope computer]]
7
8
Only processing-side of Leginon system is needed
9
10
h1. Package requirement
11
12
h2.  Python and Support Packages (Note that python 2.5 must be used):
13
14
This list does not include the python XML module because it is included in the python package for Windows.  You should generally be able to use the most recent versions of these packages that are available from their respective web sites.  Just be sure to always get the version that is compatible with Python 2.5.  If you are having trouble with the most recent version, try to use the specific versions listed here:
15
16
|Python 2.5*| "http://www.python.org":http://www.python.org||
17
|Python for Windows extension (pywin32)| "http://sourceforge.net/projects/pywin32/":http://sourceforge.net/projects/pywin32/||
18
|wxPython 2.5.2.8 or newer| "http://www.wxpython.org":http://www.wxpython.org||
19
|MySQL Python client 1.2 or newer| "http://sourceforge.net/projects/mysql-python":http://sourceforge.net/projects/mysql-python|1.2.3 doesn't have window installer, yet, use 1.2.2|
20
|Python Imaging Library (PIL) 1.1.4 or newer| "http://www.pythonware.com/products/pil/":http://www.pythonware.com/products/pil/||
21
|NumPy 1.0b5 (tested, others may work)| "http://www.scipy.org":http://www.scipy.org||
22
|SciPy 0.5.1 or newer| "http://www.scipy.org":http://www.scipy.org||
23
24
*Python 2.5 is the only python version that we have compiled numExtension. libCV and comarray in. Therefore no other python version works for now.
25
26
h2. SVN client used for check out from our repository
27
28
This required for following this instruction. We have used Tortois SVN client.  Alternatively, you may copy the required NRAMM source files from another computer.
29
30
|_.Name:|_.Download site:|
31
|Tortoise SVN client| "http://tortoisesvn.tigris.org":http://tortoisesvn.tigris.org|
32
33
34
h2.  Required supporting programs for the CCD camera from camera makers
35
36
Install and register the following programs for CCD cameras from the two makes.  Most likely, you already have these installed when the camera and TEM software was installed:
37
38
|_.Camera Make:|_.File:|
39
| Gatan|TecnaiCCD.dll|
40
| Tietz|CAMC4.exe*|
41
42
*Note:* We have experienced slowness of the CAMC4.exe comes with later version Tecnai TUI/TIA. Replacing it with an earlier version of CAMC4.exe resolved the problem
43
44
h2.  Supporting programs for film exposure
45
46
Install the following if you need film exposure on FEI Tecnai TEM through Leginon, available through FEI. Please contact Max Otten: mto@feico.com and request for adaexp.exe that works with your version of Tecnai user interface program.
47
48
|_.Name:|_.File:|
49
| exposure adaptor|adaexp.exe|
50
51
h2. Packages required from NRAMM
52
53
h3. These are the sub-packages of myami that you will install with the python installer.
54
55
|_.Name:|_.Purpose:|
56
| leginon|modular TEM image acquisition|
57
| pyami|general functions|
58
| sinedon|Leginon/database interaction|
59
| pyscope|microscope control and monitoring|
60
| imageviewer|image viewing for tomography|
61
62
*For FEI Eagle Camera or Gatan Camera that uses TIA, comarray package needs to be install with python
63
*[[Special Instructions for FEI Eagle Camera]]
64
65
Because numextension, comarray and libcv would require extra compilers if you build them yourself, we have created Windows installers for them for python 2.5 and made them available at http://emg.nysbc.org/projects/leginon/files.
66
67
h3. These are the Leginon v2.0 python 2.5 compiled packages installed through python installer on Windows. Leginon v2.1 uses the same files.
68
69
|_.Downloadfile Name|_.Purpose:|
70
|numextension-2.0.0.win32-py2.5.exe|c extension for numerical processing|
71
|comarray-2.0.0.win32-py2.5.exe|com module output conversion to array|
72
|libCV-0.2.win32-py2.5.exe|small c library of algorithm from computer vision field|
73
74
h1. Installation
75
76
h2. 1. Register TecnaiCCD.dll, CAMC4.exe (For Tietz camera), and adaexep.exe (For film exposure)
77
78
*  For example, from the command prompt:
79
<pre>adaexp.exe /regserver</pre>
80
81
h2. Install Python and supporting packages with their installers
82
83
Excute the installer files and follow the instructions.
84
85
86
h2. 2. Install the Windows Installer Files from Leginon website http://emg.nysbc.org/projects/leginon/files
87
88
Execute the installer files and follow the instructions. *Do not execute comarray-2.0.0.win32-py2.5.3x3 if your camera uses TIA*.  See earlier section above.
89
90
h2. 3. Check out SVN Source Files from the repository
91
92
Use your mouse to do the following
93
* Create Leginon2.1 directory somewhere at your convenience
94
95
* Change directory into Leginon2.1
96
97
* Right-click the mouse botton in this directory window and select Tortoise svn
98
Checkout in the menu:
99
 !http://emg.nysbc.org/software/leginon/images/images/svnmenu.png!
100
101
102
* Set up svn checkout window like this to check out from http://emg.nysbc.org/svn/myami/branches/myami-2.1 to Leginon2.1
103
 !http://emg.nysbc.org/software/leginon/images/images/svnco.png!
104
105
106
h2. 4. Install the packages you downloaded from NRAMM svn repository
107
108
* Start a command line Window from Start Menu
109
110
* Install the package in each folder with commands such as
111
<pre>cd Your_Download_Place\Leginon2.1\leginon
112
c:\\python25\python.exe setup.py install</pre>
113
Then continue with the other packages, replacing leginon with the package name. See "These are the sub-packages of myami that you will install with the python installer." section above for complete list.
114
115
h2. 5. Run updatecom.py
116
117
From a command line window:
118
119
<pre>cd C:\python25\Lib\Site-Packages\pyScope
120
C:\python25\python.exe updatecom.py</pre>
121
122
The python window appears should say show the required type libraries it found:
123
<pre>
124
Generating .py files from type libraries...
125
initializing TEM Scripting Error, cannot find typelib for "TEM Scripting"
126
initializing Tecnai Scripting done.
127
initializing TOM Moniker done.
128
initializing Tecnai Low Dose Kit done.
129
initializing Tecnai Exposure Adaptor done.
130
131
initializing Tietz CCD Camera done.
132
</pre>
133
The output is of course depending on what is available on your microscope computer.  You should have either "Tecnai Scripting" or the pairing of  "TEM Scripting" and "TOM Moniker".
134
135
You will only find Tecnai Exposure Adaptor (Scripting for film exposure) if you ask FEI for it.
136
137
The script should generate a few files in C:\\python25\Lib\win32com\gen_py with seemly scrambled names such as BC0A2B03-19FF-11D3-AE00-00A024CBA50Cx0x1x9.py
138
139
h2. 6. Configure leginon.cfg:
140
141
Follow the instructions in [[Configure leginon.cfg|Configure leginon.cfg]] located in the section for Linux installation but note the location of the configuration files follows. In addition, if the storage disk is mapped onto the Windows PC as drive Z, this mapping should be included in leginon.cfg. See below.
142
143
* Configurations for all users (Recommended on the microscope computer since users are not expected to start the main processing here)
144
145
 <pre> <Python directory>\Lib\site-packages\leginon\config\leginon.cfg</pre>
146
147
 Example:
148
 <pre> C:\Python25\Lib\site-packages\leginon\config\leginon.cfg</pre>
149
150
151
* The skeleton (default) configuration file is available at:
152
153
 <pre> C:\Python25\Lib\site-packages\leginon\config\default.cfg</pre>
154
155
156
h2. 7. Configure sinedon.cfg:
157
158
Follow instruction in [[Configure sinedon.cfg]] in the section for Linux installation but note the location of the configuration files follows.
159
160
161
 * (Recommanded on microscope computer) For all users, put sinedon.cfg with the installed package as
162
 <pre>C:\Python25\Lib\site-packages\sinedon\sinedon.cfg</pre>
163
164
165
 * Your home directory on Windows:
166
 <pre>C:\Documents and Settings\your_name></pre>
167
168
169
 * the skeleton sinedon configuration file is
170
 <pre>C:\Python25\Lib\site-packages\sinedon\examples\sinedon.cfg</pre>
171
172
h2. 8. Configure instruments.cfg:
173
174
* A template for instruments.cfg is in the installed pyscope directory as "instruments.cfg.template".  Copy it to "instruments.cfg".
175
176
* Remove the Sim Tem and Sim Cam modules in the configuration.
177
178
* Add the modules for your microscope and camera. If you have a Tietz camera, there are several choices for the "class" field.  Run the tietztest.py script that comes in pyscope to tell you your available options.  For example, if your microscope uses Tecnai Scripting Interface and you have a Gatan camera that you interface through DigitalMicrograph:
179
180
{{include(instruments.cfg for 2.1)}}
181
[[instruments.cfg for 2.2|2.2 release needs additional configuration]]
182
183
The file contains other examples of microscope and camera drivers that we distribute from NRAMM.
184
185
h2. 9. Additional setup on Tietz cameras
186
187
Register the Tietz ping callback function.  From a command line window:
188
189
<pre>cd C:\python25\Lib\Site-Packages\pyscope
190
C:\python25\python.exe tietzping.py</pre>
191
192
h2. 10. For strange dimension cameras
193
194
{{include(strange dimension cameras)}}
195
196
h2. 11. Create Leginon Admin and Leginon Client shortcut in Start menu menu under Leginon
197
198
199
This instruction applies to Windows XP.
200
201
202
 * Go to C:\Documents and Settings\All Users\Start Menu\Programs\ and create a new
203
folder named Leginon.
204
205
206
 * In another window, go to
207
 <pre>C:\Python25\Lib\site-packages\leginon</pre>
208
209
210
 * Create a shortcut from start-leginon.py as "Leginon Admin" and a shortcut from launcher.py as "Leginon Client".
211
212
213
 * Move the two shortcuts into
214
 <pre>C:\Documents and Settings\All Users\Start Menu\Programs\Leginon</pre>
215
216
217
218
h2. 12. Mapping Drives (Optional):
219
220
Although we don't recommend it, it is possible to run minimal Leginon directly on the Windows machine,  Since the database and web servers are not there, you probably will be saving the images through a Samba server on a network drive also available to the Linux machine.  If you do so, you will need to map the network drive. For example, if your Samba server has a hostname your_smbserver, and you have set up a share called [your_share_point] which points to /your_data_path/ and leginon data will be saved under a folder in /your_data_path/leginon/.
221
222
*  Start, My Computer
223
224
225
*  Tools menu, Map network drive
226
227
228
*  Use an unmapped drive such as Z:
229
230
 Enter shared path in Windows format as
231
 <pre>\\your_smbserver\your_share_point</pre>
232
233
234
*  Add the drive and the Linux path to leginon.cfg on the Windows machine as
235
 <pre>[Drive Mapping]
236
Z:/your_data_path</pre>
237
238
239
*  Add image path to leginon.cfg on the Windows machine in Linux format as
240
 <pre>[Images]
241
path:/your_data_path/leginon</pre>
242
243
244
h2.  Additional Software (Optional):
245
246 2 Neil Voss
TigerVNC (http://tigervnc.org/) -- allows remote access to windows screen. If you get tired of going into the microscope room just to open the column valves.
247 1 Anchi Cheng
248
249
______
250
251
[[Additional Database Server Setup after Web Server Installation|< Additional Database Server Setup]] | [[Steps involved in the installation| Steps needed for Installation Using Database Administration Tools >]]
252
253
254
______