Appion

h1. Administration Tools Guide

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.

h2.  Recommandation for setup at a new institute

h2. First user : administrator

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.

h2. Additional users :

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.

h2.  Steps involved in the installation

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.

h2. Go to administration page

Open a web browser. Go to http://yourhost/dbem/admin.php

h2. Add a Group

Groups are used to associate users together. At the moment, Leginon does not use the group association for anything.

*  At http://yourhost/dbem/admin.php, click on Groups.

*  Add a "name" (required) for the group.

*  Optionally enter a full name for the group.

*  Click Save.

h2.  Add Adminstrator User

*  At http://yourhost/dbem/admin.php, click on Users.

*  Add "administrator" as the user.

*  Enter a full name as "administrator". This name should be typed exactly as it is (case-sensitive).

*  Add this user to a previously created group.

*  Click Save.

h2.  Add your mircoscope as an TEM instrument

*  Click on Instruments.

*  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)

*  Enter the hostname of the microscope. Do not captalize the characters!!! (a Window's requirement)

*  Select instrument type TEM.

*  Click Save.

h2.  Add your CCD camera as an CCDCamera instrument

*  Click on Instruments.

*  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)

See the section on <link linkend="instrument_names">Instrument Tool</link> for more details.

*  Enter the hostname of the microscope. Do not captalize the characters!!! (a Window's requirement)

*  Select instrument type CCDCamera.

*  Click Save.

h2.  Load the default settings of Legion nodes

*  Click on Default Settings.

*  Click on Load.

h2.  Import Applications

*  Click on Applications.

!http://emg.nysbc.org/software/leginon/images/images/application_on.png!

* 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.

<blockquote>

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.

To find Leginon installation path on Linux:<pre> >start-leginon.py -v</pre>

On Windows, You should find a shortcut to your Leginon installation folder in the "Start Menu/All Programs/Leginon". If not, it is likely

<pre>C:\Python25\Lib\site-packages\Leginon\</pre>

</blockquote>

* !http://emg.nysbc.org/software/leginon/images/images/admin_apptable.png!

*  Select the name of the "To" Host the application will be imported to.

*  Click Import.

h2.  Proceed to First Leginon Test Run Chapter

<link linkend="runleg_chapter">Leginon test runs</link> test for tem/ccd controls and network communications. The rest of this chapter is for references.

h2.  Set up for a new regular user

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:

h2.  Add a User From Administration web page

*  Open a web browser. Go to http://yourhost/dbem/admin.php

*  Click on Users.

*  Add a "name" (required) for the user. (This is like a one-word username that people use to log into a computer).

*  Optionally enter a full name for the user. (required)

*  Add this user to a previously created group. Or, add a new group for this user. (required)

*  Click Save.

!http://emg.nysbc.org/software/leginon/images/images/user_on.png!

!http://emg.nysbc.org/software/leginon/images/images/admin_usertable.png!

h2. Get a copy of the configuration files

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.

h2. Modify leginon.cfg

Modify the [user] "Fullname" field in <command moreinfo="none">leginon.cfg</command> to correspond the "full name" field in the Leginon Administration User Tools.

h2.  More about Groups

Groups are used to associate users together. At the moment, Leginon does not use the group association for anything.

h2. Add/Edit a Group

*  Open a web browser. Go to http://yourhost/dbem/admin.php

*  Click on Groups.

*  Add a "name" (required) for the group.

*  Optionally enter a full name for the group.

*  Click Save.

h2.  Remove a Group

*  Open a web browser. Go to http://yourhost/dbem/admin.php

*  Click on Groups.

*  Highlight a group name from the list of created Groups.

*  Click Remove.

!http://emg.nysbc.org/software/leginon/images/images/group1_on.png!

!http://emg.nysbc.org/software/leginon/images/images/admin_grouptable.png!

h2.  More about Instruments

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.

h2.  Valid Instrument Names

TEM names:

*  Tecnai

Camera names:

*  Gatan

*  Tietz SCX

*  Tietz PXL

*  Tietz PVCam

*  Tietz PVCam

*  Tietz FastScan

*  Tietz FastScan Firewire

*  Tietz FC415

*  Tietz Simulation

h2.  Add/Edit an Instrument

*  Open a web browser. Go to http://yourhost/dbem/admin.php

*  Click on Instruments.

*  Add a "name" (required and not arbitrary, see the above section) for the microscope or camera.

*  Enter the hostname of the microscope. The domain suffix need not be entered if all machines are under the same hostname.

*  Select instrument type.

*  Click Save.

h2.  Remove an Instrument

*  Open a web browser. Go to http://yourhost/dbem/admin.php

*  Click on Instruments.

*  Highlight an instrument name from the list of created instruments.

*  Click Remove.

h2.  Import an Instrument Pair

*  Open a web browser. Go to http://yourhost/dbem/admin.php

*  Click on Instruments.

*  Select a From Host and the name of the Instruments.

*  Click Import.

!http://emg.nysbc.org/software/leginon/images/images/tem_tecnai_icon_on.png!

!http://emg.nysbc.org/software/leginon/images/images/admin_instrutable.png!

h2.  Applications

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.

h2.  Import Applications online

*  Open a web browser. Go to http://yourhost/dbem/admin.php

*  Click on Applications.

!http://emg.nysbc.org/software/leginon/images/images/application_on.png!

*  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.

!http://emg.nysbc.org/software/leginon/images/images/admin_apptable.png!

*  Select the name of the "To" Host the application will be imported to.

*  Click Import.

h2. Export Applications online

h2.  to another Host

*  Open a web browser. Go to http://yourhost/dbem/admin.php

*  Click on Applications.

*  Select the name of the "From" Host.

*  Select the name of the Leginon application.

*  Select the "To" Host.

*  Click "Export"

h2.  to a Leginon application XML file

*  Open a web browser. Go to http://yourhost/dbem/admin.php

*  Click on Applications.

*  Select the name of the "From" Host.

*  Select the name of the Leginon application.

*  Keep "Export to XML format" enabled.

*  Enable "Save as"

*  Click Export

h2.  to the screen in XML format

*  Open a web browser. Go to http://yourhost/dbem/admin.php

*  Click on Applications.

*  Select the name of the "From" Host.

*  Select the name of the Leginon application.

*  Keep "Export to XML format" enabled.

*  Click Export

h2.  to the screen in "easy-to-read" format

*  Open a web browser. Go to http://yourhost/dbem/admin.php

*  Click on Applications.

*  Select the name of the "From" Host.

*  Select the name of the Leginon application.

*  Select View

*  Click Export

It should contain tables of Application Data, NodeSpec Data, and likely BindingSpec Data.

h2.  Calibrations

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.

h2.  Import Calibrations

*  Open a web browser. Go to http://yourhost/dbem/admin.php

*  Click on Calibrations.

*  Enter the name of the Leginon calibration XML file.

*  Select the name of the To Host the calibrations will be imported to.

*  Click Import.

h2. Export Calibrations

h2.  to another Host

*  Open a web browser. Go to http://yourhost/dbem/admin.php

*  Click on Calibrations.

*  Select the name of the "From" Host and desired Instrument.

*  Select the names of the calibrations to export.

*  Select the "To" Host and desired Instrument.

*  Click Export

h2.  to a Leginon application XML file

*  Open a web browser. Go to http://yourhost/dbem/admin.php

*  Click on Calibrations.

*  Select the name of the "From" Host and desired Instrument.

*  Select the names of the calibrations to export.

*  Keep "Export to XML format" enabled.

*  Enable "Save as"

*  Click Export

h2.  to the screen in XML format

*  Open a web browser. Go to http://yourhost/dbem/admin.php

*  Click on Calibrations.

*  Select the name of the "From" Host and desired Instrument.

*  Select the names of the calibrations to export.

*  Keep "Export to XML format" enabled.

*  Click Export

h2.  to the screen in "easy-to-read" format

*  Open a web browser. Go to http://yourhost/dbem/admin.php

*  Click on Calibrations.

*  Select the name of the "From" Host and desired Instrument.

*  Select the names of the calibrations to export.

*  Select View

*  Click Export

!http://emg.nysbc.org/software/leginon/images/images/calibration_on.png!

!http://emg.nysbc.org/software/leginon/images/images/admin_caltable.png!

h2.  Goniometer

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.

h2.  View the Goniometer Model

*  Open a web browser. Go to http://yourhost/dbem/admin.php

*  Click on Goniometer

*  Select a model to display.

*  Click view.

!http://emg.nysbc.org/software/leginon/images/images/goniometer_on.png!

!http://emg.nysbc.org/software/leginon/images/images/admin_gontable.png!