Leginon

h1. How to Update from v1.6 (Microscope Windows Computer)

The changes from v1.6 requires update of all in-house components of Leginon, dbemtools and database but not the php-mrctools. 

Don't forget that you need to also update the packages on the microscope-controlling computer

since the pyScope update need to be synchronized.

See [[Installation Troubleshooting]] and  "Leginon Bulletin Board":http://emg.nysbc.org/projects/leginon/boards  searching

for "install" if you run into problems.

h2. Packages required from NRAMM

All Leginon (and Appion) packages distributed from NRAMM are now under one svn control.

A few updates are needed for preparation of python 3.0 compatibility where the method for importing module is changed.  They will still run under python 2.5 and up.

Here are the packages you need to install with python installer

|_.SVN subPackage Name|_.Reason for update:|

|leginon|new features|

|pyami|new features|

|sinedon|required for updating database|

|pyscope|new method for creating pythoncom modules|

|imageviewer|debug|

Because numextension and libcv requires extra compiler, we have created

window installer for them for python 2.5 and made them available at http://emg.nysbc.org/projects/leginon/files.

|_.Downloadfile Name|_.Purpose:|

|numextension-2.0.0.win32-py2.5.exe|c extension for numerical processing|

|comarray-2.0.0.win32-py2.5.exe|com module output conversion to array|

|libCV-0.2.win32-py2.5.exe|small c library of algorithm from computer vision field|

h2. Download Leginon 2.0 source code

h3. Check out SVN Source Files from the repository

Assuming that you have installed some kind of svn client such as TortoiseSVN "http://tortoisesvn.tigris.org/", you can use your mouse to do the following

* Create Leginon2.0 directory somewhere at your convenience

* Change directory into Leginon2.0

* Right-click the mouse botton in this directory window and select Tortoise svn

Checkout in the menu: !http://emg.nysbc.org/software/leginon/images/images/svnmenu.png!

* Set up svn checkout window like this, but check out from http://emg.nysbc.org/svn/myami/branches/myami-2.0 and save it to Leginon2.0 folder !http://emg.nysbc.org/software/leginon/images/images/svnco.png!

h2. Perform system check if you can't remember where you have installed your Leginon before.

* Go to ~/Leginon2.0/leginon

* Double click on syscheck.py

You should have all the supporting packages installed for v1.6. If you see any lines like "*** Failed...", then you have something missing. Otherwise, everything should result in "OK".

h2. Uninstall your existing NRAMM packages:

Although new installation overwrite the old in most cases, problem has been observed in the past. Therefore, it is best to remove the old files before new installation.

Use "Add or Remove Programs" application in "Control Panel" to do this. Leginon related

packages are shown with prefix "Python 2.5"

Remove only packages from NRAMM but not the suppporting packages.  The NRAMM packages that you may find in "Add or Remove Programs" are

|pyScope|

|numextension|

|comarray|

|libCV|

If you didn't use Installer to install previously, the packages may not show up in the

Programs list. Simply remove or rename the folder containing the old packages in this case as described next.

h2. Move your existing packages to a backup directory:

At the beginning of the syscheck.py output, the location of the exisiting Leginon folder is shown. Although new installation overwrite the old in most cases, problem has been observed in the past. Therefore, it is best to remove the old files from the path before new installation.  Better yet, copy into a backup folder because we need some configuration files from them.

You may find these folders here:

|Leginon|

|pyScope|

|sinedon|

|pyami|

|ImageViewer|

For example, your Leginon folder is at C:\\python25\Lib\site-packages\Leginon

<pre>Go to C\\python25\site-packages

Create Leginon1_6_backup folder

Move Leginon folder into Leginon1_6_backup folder</pre>

Be aware that in some cases the installed package name is different (capitalized) from your svn package name and that numextension amd libCV are not in its own subdirectory in the python library but just the compiled .so files

h2. Install the Windows Installer Files from Leginon website http://emg.nysbc.org/projects/leginon/files

Execute the installer files and follow the instructions.

h2. Install other subpackages you downloaded from NRAMM svn repository.  You don't need to repeat ones you've already installed using the installer files.

* Start a command line Window from Start Menu

* Reinstall the package in EACH of the following folders using the included setup.py

|leginon|

|pyscope|

|sinedon|

|pyami|

|imageviewer|

<pre>cd Your_Download_Place\Leginon 2.0\install_folder

c:\\python25\python.exe setup.py install</pre>

* run syscheck.py again to make sure you have everything.

h2. Copy your Leginon1.6 sinedon.cfg to the new installation

* Find your sinedon.cfg. Depending on your previous setting, look in the directories listed here in order:

*your home directory as described in syscheck.py

*The sinedon directory where it is called from. If unsure, start python command line and type these to find out:

<pre>python> import sinedon

python> sinedon</pre>

*  If sinedon.cfg reside in the installed sinedon subpackage, you should copy it from your Leginon1.6 backup to the new installation.

<pre>go to  C:\\python25\Lib\site-packages\

copy Leginon_1_6_backup\sinedon\sinedon.cfg  into the new sinedon folder

</pre>

h2. Copy your Leginon1.6 Instruments.cfg to the new installation:

* instruments.cfg is in the pyScope folder of your Leginon 1.6 backup to the new pyscope folder under site-packages directory.

h2. Run updatecom.py

From a command line window:

<pre>cd C:\python25\Lib\Site-Packages\pyScope

C:\python25\python.exe updatecom.py</pre>

The python window appears should say show the required type libraries it found:

<pre>

Generating .py files from type libraries...

initializing TEM Scripting Error, cannot find typelib for "TEM Scripting"

initializing Tecnai Scripting done.

initializing TOM Moniker done.

initializing Tecnai Low Dose Kit done.

initializing Tecnai Exposure Adaptor done.

initializing Tietz CCD Camera done.

</pre>

The output depending on what is available on your microscope computer.  You should have either "Tecnai Scripting" or the pairing of  "TEM Scripting" and "TOM Moniker".

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

h2. modify Tietz PXL camera imaging size if you did so before for Leginon 1.6

*You should not copy the old one in this case since the file has been changed*

*  Go to C:\Python25\Lib\site-packages\pyscope\

*  Edit tietz.py with a plain text editor

*  Find the lines:

<pre> def getCameraSize(self):

# {'type': dict, 'values': {'x': {'type': int}, 'y': {'type': int}}}}

x = self._getParameterValue('cpTotalDimensionX')

y = self._getParameterValue('cpTotalDimensionY')

return {'x': x, 'y': y}

</pre>

*  Change the last line to:

<pre>    return {'x': 2048, 'y': 2048}</pre>

h2. Perform [[TEM_Scripting_Beam_Tilt_Calibration]] if this is an FEI microscope.

______

[[How_to_Update_from_v16_(Linux)|< How to Update from v1.6 (Linux)]] | [[Preparation before Using v2.x Routinely|Preparation before Using v2.x Routinely >]]

______