Project

General

Profile

Installation on the microscope computer » History » Version 70

Anchi Cheng, 04/23/2013 03:17 PM

1 56 Anchi Cheng
h1. Installation on the microscope computer for 2.2
2 1 Amber Herold
3 65 Anchi Cheng
h2. If you are installing 2.1, see [[Installation on the microscope compute 2.1]]
4 54 Anchi Cheng
5 11 Anchi Cheng
Only processing-side of Leginon system is needed
6 1 Amber Herold
7 21 Anchi Cheng
h1. Package requirement
8 1 Amber Herold
9 21 Anchi Cheng
h2.  Python and Support Packages (Note that python 2.5 must be used):
10 1 Amber Herold
11 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:
12 11 Anchi Cheng
13 38 Anchi Cheng
|Python 2.5*| "http://www.python.org":http://www.python.org||
14
|Python for Windows extension (pywin32)| "http://sourceforge.net/projects/pywin32/":http://sourceforge.net/projects/pywin32/||
15
|wxPython 2.5.2.8 or newer| "http://www.wxpython.org":http://www.wxpython.org||
16 39 Anchi Cheng
|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|
17 38 Anchi Cheng
|Python Imaging Library (PIL) 1.1.4 or newer| "http://www.pythonware.com/products/pil/":http://www.pythonware.com/products/pil/||
18
|NumPy 1.0b5 (tested, others may work)| "http://www.scipy.org":http://www.scipy.org||
19
|SciPy 0.5.1 or newer| "http://www.scipy.org":http://www.scipy.org||
20 1 Amber Herold
21 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.
22
23 21 Anchi Cheng
h2. SVN client used for check out from our repository
24 12 Anchi Cheng
25
This required for following this instruction. We have used Tortois SVN client.  Alternatively, you may copy the required NRAMM source files from another computer.
26
27
|_.Name:|_.Download site:|
28 11 Anchi Cheng
|Tortoise SVN client| "http://tortoisesvn.tigris.org":http://tortoisesvn.tigris.org|
29
30 1 Amber Herold
31 21 Anchi Cheng
h2.  Required supporting programs for the CCD camera from camera makers
32 1 Amber Herold
33 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:
34 1 Amber Herold
35
|_.Camera Make:|_.File:|
36
| Gatan|TecnaiCCD.dll|
37
| Tietz|CAMC4.exe*|
38 63 Anchi Cheng
| DirectElectronDE12|DirectElectronAPI.exe|
39 1 Amber Herold
40 21 Anchi Cheng
h2.  Supporting programs for film exposure
41 11 Anchi Cheng
42 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.
43 11 Anchi Cheng
44
|_.Name:|_.File:|
45 1 Amber Herold
| exposure adaptor|adaexp.exe|
46
47 21 Anchi Cheng
h2. Packages required from NRAMM
48 11 Anchi Cheng
49 25 Jim Pulokas
h3. These are the sub-packages of myami that you will install with the python installer.
50 11 Anchi Cheng
51 1 Amber Herold
|_.Name:|_.Purpose:|
52 11 Anchi Cheng
| leginon|modular TEM image acquisition|
53
| pyami|general functions|
54
| sinedon|Leginon/database interaction|
55
| pyscope|microscope control and monitoring|
56
| imageviewer|image viewing for tomography|
57
58 47 Anchi Cheng
*For FEI Eagle Camera or Gatan Camera that uses TIA, comarray package needs to be install with python
59 46 Jim Pulokas
*[[Special Instructions for FEI Eagle Camera]]
60 1 Amber Herold
61 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.
62 11 Anchi Cheng
63 65 Anchi Cheng
h3. These are the Leginon v2.0 python 2.5 compiled packages installed through python installer on Windows. Leginon v2.2 uses the same files.
64 1 Amber Herold
65 17 Anchi Cheng
|_.Downloadfile Name|_.Purpose:|
66
|numextension-2.0.0.win32-py2.5.exe|c extension for numerical processing|
67 45 Jim Pulokas
|comarray-2.0.0.win32-py2.5.exe|com module output conversion to array|
68 70 Anchi Cheng
|libCV-2.0.0.win32-py2.5.exe|small c library of algorithm from computer vision field|
69 11 Anchi Cheng
70 21 Anchi Cheng
h1. Installation
71 11 Anchi Cheng
72 68 Anchi Cheng
{{include(add host)}}
73 66 Anchi Cheng
74 60 Anchi Cheng
h2. Register TecnaiCCD.dll, CAMC4.exe (For Tietz camera), and adaexp.exe (For film exposure)
75 1 Amber Herold
76 59 Jim Pulokas
*  From the command prompt, run the following commands.  You may need to enter the full path of the exe or dll:
77 58 Jim Pulokas
<pre>adaexp.exe /regserver
78
CAMC4.exe /regserver
79 59 Jim Pulokas
REGSVR32 TecnaiCCD.dll</pre>
80 18 Anchi Cheng
81 26 Jim Pulokas
h2. Install Python and supporting packages with their installers
82 11 Anchi Cheng
83 26 Jim Pulokas
Excute the installer files and follow the instructions.
84 11 Anchi Cheng
85 12 Anchi Cheng
86 60 Anchi Cheng
h2. Install the Windows Installer Files from Leginon website http://emg.nysbc.org/projects/leginon/files
87 1 Amber Herold
88 49 Anchi Cheng
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 1 Amber Herold
90 60 Anchi Cheng
h2. Check out SVN Source Files from the repository
91 1 Amber Herold
92 11 Anchi Cheng
Use your mouse to do the following
93 65 Anchi Cheng
* Create Leginon2.2 directory somewhere at your convenience
94 1 Amber Herold
95 65 Anchi Cheng
* Change directory into Leginon2.2
96 1 Amber Herold
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 11 Anchi Cheng
101 1 Amber Herold
102 65 Anchi Cheng
* Set up svn checkout window like this to check out from http://emg.nysbc.org/svn/myami/branches/myami-2.2 to Leginon2.2
103 11 Anchi Cheng
 !http://emg.nysbc.org/software/leginon/images/images/svnco.png!
104
105
106 60 Anchi Cheng
h2. Install the packages you downloaded from NRAMM svn repository
107 1 Amber Herold
108 11 Anchi Cheng
* Start a command line Window from Start Menu
109 1 Amber Herold
110 12 Anchi Cheng
* Install the package in each folder with commands such as
111 65 Anchi Cheng
<pre>cd Your_Download_Place\Leginon2.2\leginon
112 12 Anchi Cheng
c:\\python25\python.exe setup.py install</pre>
113 50 Neil Voss
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 12 Anchi Cheng
115 60 Anchi Cheng
h2. Run updatecom.py
116 1 Amber Herold
117 33 Jim Pulokas
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 1 Amber Herold
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 64 Anchi Cheng
{{include(locate global config directory on Windows)}}
140 60 Anchi Cheng
141
h2. Configure leginon.cfg:
142
143 40 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 below.
144
145 60 Anchi Cheng
* Configurations for all users and all local copy and installation of leginon (Recommended on the microscope computer since users are not expected to start the main processing here)
146 55 Anchi Cheng
147 61 Anchi Cheng
 <pre> <Global configuration directory>\leginon.cfg</pre>
148 11 Anchi Cheng
149 55 Anchi Cheng
 Example:
150 61 Anchi Cheng
 <pre> C:\Programs\myami\leginon.cfg</pre>
151 11 Anchi Cheng
152 1 Amber Herold
153 40 Anchi Cheng
* The skeleton (default) configuration file is available at:
154 55 Anchi Cheng
155 1 Amber Herold
 <pre> C:\Python25\Lib\site-packages\leginon\leginon.cfg.template</pre>
156
157 33 Jim Pulokas
158 60 Anchi Cheng
h2. Configure sinedon.cfg:
159 11 Anchi Cheng
160 1 Amber Herold
Follow instruction in [[Configure sinedon.cfg]] in the section for Linux installation but note the location of the configuration files follows.
161
162 10 Anchi Cheng
163 61 Anchi Cheng
 * (Recommanded on microscope computer) For all users, put sinedon.cfg in the *global configuration directory* such as
164
 <pre>C:\Programs\myami\sinedon.cfg</pre>
165 1 Amber Herold
166
 * the skeleton sinedon configuration file is
167 10 Anchi Cheng
 <pre>C:\Python25\Lib\site-packages\sinedon\examples\sinedon.cfg</pre>
168 1 Amber Herold
169
h2. Configure instruments.cfg:
170
171 61 Anchi Cheng
* A template for instruments.cfg is in the installed pyscope directory as "instruments.cfg.template".  Copy it to
172
 <pre>C:\Programs\myami\instruments.cfg</pre>
173 60 Anchi Cheng
174 1 Amber Herold
* Remove the Sim Tem and Sim Cam modules in the configuration.
175
176 61 Anchi Cheng
* Add the modules for your microscope and camera. 
177
** If you have Direct Electron camera DE12, your camera module.class is de.DE12
178
** If your microscope uses Tecnai Scripting Interface, youe scope module.class is tecnai.Tecnai
179
** If you have a Gatan camera that you interface through DigitalMicrograph, your camera module.class is gatan.Gatan
180 62 Anchi Cheng
** 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.
181
182 55 Anchi Cheng
{{include(instruments.cfg for 2.2)}}
183 1 Amber Herold
184
The file contains other examples of microscope and camera drivers that we distribute from NRAMM.
185
186 60 Anchi Cheng
h2. Additional setup on Tietz cameras
187 1 Amber Herold
188 42 Anchi Cheng
Register the Tietz ping callback function.  From a command line window:
189 29 Jim Pulokas
190 1 Amber Herold
<pre>cd C:\python25\Lib\Site-Packages\pyscope
191
C:\python25\python.exe tietzping.py</pre>
192 57 Jim Pulokas
193 1 Amber Herold
Troubleshooting Tietz cameras:
194 57 Jim Pulokas
195
When Leginon initializes the camera, a program called CAMC4 should start automatically in the backgound.  This is confirmed by the little camera icon showing up in the system tray in the lower right of the screen.  Also, task manager can be started to confirm CAMC4 is running.  Sometimes problems occur if more than one CAMC4 is running at the same time, so task manager will help identify this.
196
197
CAMC4 has its own configuration file "CAMC.ini" that will normally be set up already, but you can search for it on your computer and confirm that everything looks right.  It will have configuration parameters for several cameras and only one of them will be activated.  The only parameter that may need some adjustment is the readout geometry, which affects the rotation and mirror of the image.
198
199
If Leginon is not initializing the camera or not getting proper images, you should first test image acquisition using TVIPS software to make sure it is not a hardware issue.  Use TCL or there is a test program called TestMFCCamera that can acquire an image and test the CAMC4 operation.
200
201 60 Anchi Cheng
h2. For strange dimension cameras
202 1 Amber Herold
203 36 Anchi Cheng
{{include(strange dimension cameras)}}
204 1 Amber Herold
205 60 Anchi Cheng
h2. Create Leginon Admin and Leginon Client shortcut in Start menu menu under Leginon
206 1 Amber Herold
207
208 11 Anchi Cheng
This instruction applies to Windows XP.
209 1 Amber Herold
210
211
 * Go to C:\Documents and Settings\All Users\Start Menu\Programs\ and create a new
212 11 Anchi Cheng
folder named Leginon.
213
214 1 Amber Herold
215
 * In another window, go to
216
 <pre>C:\Python25\Lib\site-packages\leginon</pre>
217 11 Anchi Cheng
218
219 51 Neil Voss
 * Create a shortcut from start-leginon.py as "Leginon Admin" and a shortcut from launcher.py as "Leginon Client".
220 11 Anchi Cheng
221 1 Amber Herold
222 11 Anchi Cheng
 * Move the two shortcuts into
223
 <pre>C:\Documents and Settings\All Users\Start Menu\Programs\Leginon</pre>
224
225
226
227 60 Anchi Cheng
h2. Mapping Drives (Optional):
228 11 Anchi Cheng
229 40 Anchi Cheng
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/.
230 11 Anchi Cheng
231
*  Start, My Computer
232
233
234
*  Tools menu, Map network drive
235
236
237
*  Use an unmapped drive such as Z:
238
239 12 Anchi Cheng
 Enter shared path in Windows format as
240 11 Anchi Cheng
 <pre>\\your_smbserver\your_share_point</pre>
241
242
243 12 Anchi Cheng
*  Add the drive and the Linux path to leginon.cfg on the Windows machine as
244 11 Anchi Cheng
 <pre>[Drive Mapping]
245
Z:/your_data_path</pre>
246
247
248 12 Anchi Cheng
*  Add image path to leginon.cfg on the Windows machine in Linux format as
249 11 Anchi Cheng
 <pre>[Images]
250
path:/your_data_path/leginon</pre>
251
252
253
h2.  Additional Software (Optional):
254 3 Amber Herold
255 12 Anchi Cheng
TightVNC (http://www.tightvnc.com) if you get tired of going into the microscope room just to open the column valves.
256 1 Amber Herold
257 69 Jim Pulokas
h2. Gatan K2 Experimental support:
258
259
* [[Gatan K2 Installation Notes]]
260 3 Amber Herold
261 1 Amber Herold
______
262
263 41 Anchi Cheng
[[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 >]]
264 1 Amber Herold
265
266
______