Release Notes for LICOS L01-02-00 (last updated 02/22/2006, JHP):

The latest revision of this document is located here.

Installing LICOS

Installing LICOS

  1. Put LICOS installation instructions and dependencies here.
  2. Setting up the cfg files:

  3. For the Script Engine  to operate properly scriptEngine.cfg.sample, runId.cfg.sample and vsc.cfg.sample should be copied as configName.cfg, runId.cfg and vsc.cfg respectively and modified based on the requirements of the environment.
  4. Modify configName.cfg and add any additional instrument types, particle types, orientation and phase values.  All the other settings can be changed within the Script Engine preferences dialog.
  5. Modify runId.cfg and change the machineId to a value that is unique within your site.
  6. In order to start Script Engine with the modified configuration use the --config configName.cfg command line option.
  7. If you have copied runId.cfg to a location other than the LICOS/start directory specify its location in the runId.cfg directory entry in preferences (Don't forget to click on the SAVE button after making the changes).
  8. Verifying LICOS installation:

  9. Put LICOS installation verification instructions here.

Displaying software and hardware versions:
In order to run the "versions" utility, at the command prompt change the directory to "$ONLINE_ROOT/LICOS_ETC" and type "versions.sh --server servername".  This should output version info for all modules loaded.

To begin writing LICOS scripts, refer to the test scripts in the $ONLINE_ROOT/tests/scriptEngine directory for orientation.

Running the Script Engine:
 Script Engine needs to be started from the LICOS/start directory as follows:
    scriptEngine.sh  --server servername --config configFilename --vscConfig vsc.cfg
Example:
   
scriptEngine.sh  --server lat-elf21 --config scriptEngine.cfg --vscConfig vsc.cfg

Upgrading LICOS:

Troubleshooting:

Dependencies, Bug Fixes, and New Features:

Bug Fixes, JIRAs, Features

Flight Software Release:

Qt and PyQt Related:

LDF:

Hippodraw:

ELogbook:

Supplemental Notes/Information:

Command Line Options:

usage: startScriptEngine.py --config <configname> --server <servername> --vscConfig <vscConfigname> [--noreload <noreloadname>] [--securedir <securedirname>] [--cvtHost <cvtHostname>] [--cvtPort <cvtPortname>] [--scriptOpts <scriptOptsname>] [--norcoverride] [--paramverify]

Detailed explanation:

Mandatory options:
--config to specify the run control configuration file to use
--server to specify the hostname or the IP address of the teststand crate to connect to.
--vscConfig to specify the configuration of the VSC and related quantities

Optional options:
--app Specify the standalone application or suite to run. Typically used by test or suite runners.
--appdir Specify the application directory
--cvtHost Current value table host.
--cvtPort Current value table port.
--diagHost Diagnostic proxy host. If omitted, defaults to localhost.
--norcoverride Prevents the run conditions to be overridden with NOT-DEFINED.
--noreload Specify a file that contains prefixes of modules which should not be reloaded when a user script is selected.
This list gets appended to the default list which currently contains the following prefixes 'scipy', 'weave', 'qwt', 'xml', 'pyexpat', 'win32'. The file should contain one prefix per line.
--paramverify Force the parameter verifier to come up even if running in non-secure mode.
--scriptOpts Specify a configuration file containing script specific options. The script name is specified as a section and all options can be specified under that section.
--securedir The full path to the secure directory where the password file ("passwords") and the user permissions file ("security.cfg") is stored. If this switch is specified then ScriptEngine is started in secure mode.
--telemHost Telemetry proxy host. If omitted, defaults to localhost.
 

Run Report Tags:

The following table contains a list of all LICOS supported tags which may appear in a run report (rcReport.out):

TestName Name of the script run
SuiteName Name of the suite run
RunId Unique 9 digit identifier for the run.  The run's most significant three digits corresponds to a machine id, the other 6 digits forn a sequence number that gets incremented with every run
Operator Name of the operator running the test
OperatorId Three digit id of the operator as specified in runcontrol.cfg
PauseCount Number of times the test was paused.
PausedTime Total number of seconds spent in paused state.
StartTime The timestamp for the start of the test in the form of a tuple.
ElapsedTime Total number of seconds spent during the execution of the test.
EndTime The timestamp for the end of the test in the form of a tuple.
FreeDiskSpace Free disk space for the C: drive on Windows and current working directory for Unix.
AssociatedFiles Any files exported by the user script by calling the addExportedFile method.
VersionData A dictionary of key, value pairs containing software and  hardware identifiers and their versions.
Release A dictionary of key, value pairs containing LICOS and subsystem identifiers and their release tags.
ModulesFailedVerification A list of modules and schema files which failed the checksum verification.
LogFile Name of the session level log file generated.
RunLogFile Name of the run level log file generated.
Comments List of comment strings inputted by the operator and the system.
Site Test site
ParticleType Particle Type
InstrumentType Instrument Type
Orientation Orientation
Phase Phase
ParamVerify Indicates that the parameter verifier was activated during the run.
ScriptReport Name of the test report produced at the end of the run.
ErrorLogCount Number of error log messages that were output since the run started.
CompletionStatus Integer value indicating the completion status for that run.
CompletionStatusStr String value indicating the completion status for that run.
ScriptOptions Script specific options.

 

Version Information:

(Retrieved by running versions.sh --server servername while in $ONLINE_ROOT/LICOS_ETC directory)

Module

Version


Please contact Selim Tuvi, Ric Claus, Lester Miller or Jim Panetta if you have problems or any questions (Contacts Page)

Back