Project

General

Profile

Installation on the microscope computer » History » Version 28

Jim Pulokas, 06/02/2010 12:03 PM

1 11 Anchi Cheng
h1. Installation on the microscope computer
2 1 Amber Herold
3 11 Anchi Cheng
Only processing-side of Leginon system is needed
4 1 Amber Herold
5 21 Anchi Cheng
h1. Package requirement
6 1 Amber Herold
7 21 Anchi Cheng
h2.  Python and Support Packages (Note that python 2.5 must be used):
8 1 Amber Herold
9 24 Jim Pulokas
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:
10 11 Anchi Cheng
11
|Python 2.5*| "http://www.python.org":http://www.python.org|
12
|Python for Windows extension (pywin32)| "http://sourceforge.net/projects/pywin32/":http://sourceforge.net/projects/pywin32/|
13
|wxPython 2.5.2.8 or newer| "http://www.wxpython.org":http://www.wxpython.org|
14
|MySQL Python client 1.2 or newer| "http://sourceforge.net/projects/mysql-python":http://sourceforge.net/projects/mysql-python|
15
|Python Imaging Library (PIL) 1.1.4 or newer| "http://www.pythonware.com/products/pil/":http://www.pythonware.com/products/pil/|
16
|NumPy 1.0b5 (tested, others may work)| "http://www.scipy.org":http://www.scipy.org|
17 1 Amber Herold
|SciPy 0.5.1 or newer| "http://www.scipy.org":http://www.scipy.org|
18
19 12 Anchi Cheng
*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.
20
21 21 Anchi Cheng
h2. SVN client used for check out from our repository
22 12 Anchi Cheng
23
This required for following this instruction. We have used Tortois SVN client.  Alternatively, you may copy the required NRAMM source files from another computer.
24
25
|_.Name:|_.Download site:|
26 11 Anchi Cheng
|Tortoise SVN client| "http://tortoisesvn.tigris.org":http://tortoisesvn.tigris.org|
27
28 1 Amber Herold
29 21 Anchi Cheng
h2.  Required supporting programs for the CCD camera from camera makers
30 1 Amber Herold
31 25 Jim Pulokas
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:
32 1 Amber Herold
33
|_.Camera Make:|_.File:|
34
| Gatan|TecnaiCCD.dll|
35 11 Anchi Cheng
| Tietz|CAMC4.exe*|
36 1 Amber Herold
37 11 Anchi Cheng
*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
38 1 Amber Herold
39 21 Anchi Cheng
h2.  Supporting programs for film exposure
40 11 Anchi Cheng
41 12 Anchi Cheng
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.
42 11 Anchi Cheng
43
|_.Name:|_.File:|
44 1 Amber Herold
| exposure adaptor|adaexp.exe|
45
46 21 Anchi Cheng
h2. Packages required from NRAMM
47 11 Anchi Cheng
48 25 Jim Pulokas
h3. These are the sub-packages of myami that you will install with the python installer.
49 11 Anchi Cheng
50 1 Amber Herold
|_.Name:|_.Purpose:|
51 11 Anchi Cheng
| leginon|modular TEM image acquisition|
52
| pyami|general functions|
53
| sinedon|Leginon/database interaction|
54
| pyscope|microscope control and monitoring|
55
| imageviewer|image viewing for tomography|
56
57 25 Jim Pulokas
*For Gatan Camera or FEI Eagle Camera that uses TIA, comarray package needs to be install with python
58 1 Amber Herold
59
60 25 Jim Pulokas
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.
61 11 Anchi Cheng
62 21 Anchi Cheng
h3. These are the Leginon v2.0 python 2.5 compiled packages installed through python installer on Windows.
63 1 Amber Herold
64 17 Anchi Cheng
|_.Downloadfile Name|_.Purpose:|
65
|numextension-2.0.0.win32-py2.5.exe|c extension for numerical processing|
66
|comarray-2.0.0.win32-py2.5.exe|com module output conversion to array|
67
|libCV-0.2.win32-py2.5.exe|small c library of algorithm from computer vision field|
68 11 Anchi Cheng
69 21 Anchi Cheng
h1. Installation
70 11 Anchi Cheng
71 21 Anchi Cheng
h2. 1. Register TecnaiCCD.dll, CAMC4.exe, and adaexep.exe
72 19 Anchi Cheng
73 20 Anchi Cheng
*  For example, from the command prompt:
74
<pre>adaexp.exe /regserver</pre>
75 18 Anchi Cheng
76 26 Jim Pulokas
h2. Install Python and supporting packages with their installers
77 11 Anchi Cheng
78 26 Jim Pulokas
Excute the installer files and follow the instructions.
79 11 Anchi Cheng
80 12 Anchi Cheng
81 26 Jim Pulokas
h2. 2. Install the Windows Installer Files from Leginon website http://emg.nysbc.org/projects/leginon/files
82 1 Amber Herold
83 26 Jim Pulokas
Execute the installer files and follow the instructions.
84 1 Amber Herold
85 26 Jim Pulokas
h2. 3. Check out SVN Source Files from the repository
86 1 Amber Herold
87 11 Anchi Cheng
Use your mouse to do the following
88
* Create Leginon2.0 directory somewhere at your convenience
89 1 Amber Herold
90
* Change directory into Leginon2.0
91
92
* Right-click the mouse botton in this directory window and select Tortoise svn
93
Checkout in the menu:
94
 !http://emg.nysbc.org/software/leginon/images/images/svnmenu.png!
95 11 Anchi Cheng
96 1 Amber Herold
97 23 Anchi Cheng
* Set up svn checkout window like this to check out from http://emg.nysbc.org/svn/myami/branches/myami-2.0 to Leginon2.0
98 11 Anchi Cheng
 !http://emg.nysbc.org/software/leginon/images/images/svnco.png!
99
100
101 27 Jim Pulokas
h2. 4. Install the packages you downloaded from NRAMM svn repository
102 1 Amber Herold
103 11 Anchi Cheng
* Start a command line Window from Start Menu
104 1 Amber Herold
105 12 Anchi Cheng
* Install the package in each folder with commands such as
106
<pre>cd Your_Download_Place\Leginon2.0\leginon
107
c:\\python25\python.exe setup.py install</pre>
108 28 Jim Pulokas
Then continue with the other packages, replacing leginon with the package name.
109 12 Anchi Cheng
110 21 Anchi Cheng
h2. 5. Configure leginon.cfg:
111 11 Anchi Cheng
112 12 Anchi Cheng
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 above.
113 1 Amber Herold
114
* Configurations for all users
115 11 Anchi Cheng
116 1 Amber Herold
 <pre> <Python directory>\Lib\site-packages\Leginon\config\leginon.cfg</pre>
117 11 Anchi Cheng
118 1 Amber Herold
 Example:
119 11 Anchi Cheng
 <pre> C:\Python25\Lib\site-packages\Leginon\config\leginon.cfg</pre>
120
121 1 Amber Herold
122 11 Anchi Cheng
* Configurations for individual users
123 1 Amber Herold
124 11 Anchi Cheng
 <pre> <Home directory>\leginon.cfg</pre>
125
126 1 Amber Herold
 Example:
127
 <pre> C:\Documents and Settings\Leginon User\leginon.cfg </pre>
128 10 Anchi Cheng
129 11 Anchi Cheng
130 1 Amber Herold
* A skeleton (default) configuration file is available:
131 11 Anchi Cheng
132 1 Amber Herold
 <pre> C:\Python25\Lib\site-packages\Leginon\config\default.cfg</pre>
133
134 11 Anchi Cheng
135 21 Anchi Cheng
h2. 6. Configure sinedon.cfg:
136 1 Amber Herold
137 12 Anchi Cheng
Follow instruction in [[Configure sinedon.cfg]] in the section for Linux installation but note the location of the configuration files follows.
138 11 Anchi Cheng
139
140 1 Amber Herold
 * For all users, put sinedon.cfg with the installed package as
141
 <pre>C:\Python25\Lib\site-packages\sinedon\sinedon.cfg</pre>
142 11 Anchi Cheng
143
144 1 Amber Herold
 * Your home directory on Windows:
145
 <pre>C:\Documents and Settings\your_name></pre>
146 11 Anchi Cheng
147
148 1 Amber Herold
 * the skeleton sinedon configuration file is
149
 <pre>C:\Python25\Lib\site-packages\sinedon\examples\sinedon.cfg</pre>
150
151 21 Anchi Cheng
h2. 7. Modify instruments.cfg:
152 1 Amber Herold
153 16 Anchi Cheng
* The file is in the installed pyscope directory
154
155
* Remove the Sim Tem and Sim Cam modules in the configuration.
156
157
* Add the modules for your microscope and camera. For example, if your microscope uses Tecnai Scripting Interface and you have a Gatan camera that you interface through DigitalMicrograph:
158 1 Amber Herold
159
<pre>[tem]
160 10 Anchi Cheng
class: tecnai.Tecnai
161
[camera]
162
class: gatan.Gatan</pre>
163 1 Amber Herold
164 10 Anchi Cheng
The file contains other examples of microscope and camera drivers that we distribute from NRAMM.
165
166 21 Anchi Cheng
h2. 8. Run updatecom.py
167 10 Anchi Cheng
168
From a command line window:
169 1 Amber Herold
170 10 Anchi Cheng
<pre>cd C:\python25\Lib\Site-Packages\pyScope
171
C:\python25\python.exe updatecom.py</pre>
172
173
The python window appears should say show the required type libraries it found:
174 1 Amber Herold
<pre>
175
Generating .py files from type libraries...
176
initializing TEM Scripting Error, cannot find typelib for "TEM Scripting"
177
initializing Tecnai Scripting done.
178
initializing TOM Moniker done.
179
initializing Tecnai Low Dose Kit done.
180
initializing Tecnai Exposure Adaptor done.
181
182
initializing Tietz CCD Camera done.
183
</pre>
184
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".
185
186
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
187
188
189 21 Anchi Cheng
h2. 9. Additional setup on Tietz PXL camera (Optional but recommended)
190 1 Amber Herold
191
192 12 Anchi Cheng
The actual Tietz PXL camera dimension is slightly larger than 2048 x 2048. If you'd like to take the images using the maximum of 2048 x 2048 pixels, you may modify the function that get camera dimension in tietz.py of pyScope package.
193 1 Amber Herold
194
195
*  Go to C:\Python25\Lib\site-packages\pyScope\
196
197
198
*  Edit tietz.py with a plain text editor
199
200
201
*  Find the lines:
202
203
<pre> def getCameraSize(self):
204
# {'type': dict, 'values': {'x': {'type': int}, 'y': {'type': int}}}}
205
x = self._getParameterValue('cpTotalDimensionX')
206
y = self._getParameterValue('cpTotalDimensionY')
207
return {'x': x, 'y': y}
208
</pre>
209
210
*  Change the last line to:
211
212 11 Anchi Cheng
<pre>    return {'x': 2048, 'y': 2048}</pre>
213 1 Amber Herold
214 21 Anchi Cheng
h2. 10. Create Leginon and Leginon Client shortcut in Start menu menu under Leginon
215 1 Amber Herold
216
217
This instruction applies to Windows XP.
218 11 Anchi Cheng
219 1 Amber Herold
220
 * Go to C:\Documents and Settings\All Users\Start Menu\Programs\ and create a new
221
folder named Leginon.
222 11 Anchi Cheng
223
224 1 Amber Herold
 * In another window, go to
225
 <pre>C:\Python25\Lib\site-packages\leginon</pre>
226 11 Anchi Cheng
227
228
 * Create a shortcut from start-leginon.py as Leginon and a shortcut from launcher.py as Leginon Client.
229
230 1 Amber Herold
231 11 Anchi Cheng
 * Move the two shortcuts into
232
 <pre>C:\Documents and Settings\All Users\Start Menu\Programs\Leginon</pre>
233
234
235
236 21 Anchi Cheng
h2. 11. Mapping Drives (Optional):
237 11 Anchi Cheng
238
If you plan to run Leginon directly on the Windows machine, and your data files are served through a Samba server on a Linux machine, 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/.
239
240
*  Start, My Computer
241
242
243
*  Tools menu, Map network drive
244
245
246
*  Use an unmapped drive such as Z:
247
248 12 Anchi Cheng
 Enter shared path in Windows format as
249 11 Anchi Cheng
 <pre>\\your_smbserver\your_share_point</pre>
250
251
252 12 Anchi Cheng
*  Add the drive and the Linux path to leginon.cfg on the Windows machine as
253 11 Anchi Cheng
 <pre>[Drive Mapping]
254
Z:/your_data_path</pre>
255
256
257 12 Anchi Cheng
*  Add image path to leginon.cfg on the Windows machine in Linux format as
258 11 Anchi Cheng
 <pre>[Images]
259
path:/your_data_path/leginon</pre>
260
261
262
h2.  Additional Software (Optional):
263 3 Amber Herold
264 12 Anchi Cheng
TightVNC (http://www.tightvnc.com) if you get tired of going into the microscope room just to open the column valves.
265 1 Amber Herold
266 3 Amber Herold
267 1 Amber Herold
______
268
269 15 Anchi Cheng
[[Web Server Installation|< Web Server Installation]] | [[Steps involved in the installation| Steps needed for Installation Using Database Administration Tools >]]
270 1 Amber Herold
271
272
______