user documentation for installing gloria software package. · d-6.4 ver.01 sep. 15, 2013 user...

D-6.4 ver.01 Sep. 15, 2013 User documentation for installing GLORIA software package.

GLORIA is funded by the European Union 7th Framework Programme

(FP7/2007-2013) under grant agreement n° 283783

User documentation for installing GLORIA software package.

Deliverable 6.4

CODE: DEL-70VERSION: 01

DATE: September 15, 2013

http :// gloria - project . eu 1/17


Authors: Aleksander Filip ŻARNECKI, Stanislav VITEK

Collaborators: Arkadiusz CWIEK, Ariel MAJCHER, Marcin ZAREMBA

Revised by: Fernando SERENA (UPM)

Approved by: Fernando SERENA (UPM)



Distribution List:

Name Affiliation Date

Fernando SERENA UPM September 30, 2013



Change Control

General revision

Issue Date Section Page Change Description

01 Sep 15, 2013 All All Creation

Reference Documents

Nº Document Name Code



Index

1. INTRODUCTION …............................................................................................................. 7

2. DOCUMENTATION FOR INSTALLING GLORIA PACKAGES..................................... 7

2.1 RTS2 …................................................................................................................. 7

2.2 RTI Interactive Mode …....................................................................................... 7

2.3 RTIsch Batch Mode ….......................................................................................... 12

2.4 Luiza framework …................................................................................................15

3. LUIZA Framework …......................................................................................................... 17



1. INTRODUCTION

GLORIA is about to enter the third year of the project. Most of core software has already been developed and most of planned functionality is already available to users. One of the basic assumptions when developing the software was to keep it as user friendly as possible. This includes also software package installation. However, one should keep in mind that most GLORIA users will never have to install any GLORIA software as most of the functionality offered is based on web 2.0 interfaces. Only most experienced users and/or telescope owners will be expected to install some software packages. Therefore the documentation for installing the packages assumes some level of experience both in astronomy, robotic telescopes, programming (at least work with git versioning building and deployment) and system administration (at least Tomcat installation and proper configuration).

2. DOCUMENTATION FOR INSTALLING GLORIA PACKAGES

Within the GLORIA project different software packages were developed. Below we describe available documentation for software installation for subsequent packages. Please find current version on the HOWTO section of htpp://support.gloria-project.eu website.

Development environment

Main development tool used for building of the GLORIA packages is commercially-friendly open source software Eclipse (http :// www . eclipse . org ). There are two possible ways, how to configure Eclipse to be able download, build and run GLORIA packages.

A. Download Eclipse Standard edition and install GIT client and other packages, if necessaryB. Download Eclipse IDE for Java EE developers

For the local testing within Eclipse environment is necessary to have Tomcat server properly installed.

One can follow the same directory structure as developers (c:\repositorio\workspace\eclipsews), but it is recommended to create new extra workspace for GLORIA packages (especially if host OS is different from Microsoft Windows) and download all packages into this workspace to avoid compilation problem.

If user use custom workspace for development, it is necessary to configure classpath after download. It can be done manually in Eclipse environment, or using simple bash (or another favorite scripting language) script.

2.1 RTS2

RTS2 is the robotic telescope control system, which takes care of all tasks related to doing observations with it, including control of all telescope equipment and additional devices as weather station, dome etc. RTS2 Quick Start Guide, describing how to install and configure RTS2 software package at users computer was prepared by RTS2 developers and is available from the GLORIA Support page (GLORIA > Gloria Support > Resources > Document Repository > Manuals > Installation > Software Installation Manual ). User will find all information there, required to start using RTS2 in his observatory.

2.2 RTI Interactive Mode

Gloria solution for interactive mode can be found in Github repositories:a. Repositories for RTS2 telescopes:


http://www.eclipse.org/

http://users.gloria-project.eu/web/support/document-repository?p_p_id=20&p_p_lifecycle=0&p_p_state=normal&p_p_mode=view&p_p_col_id=column-1&p_p_col_count=1&_20_struts_action=%2Fdocument_library%2Fview_file_entry&_20_fileEntryId=31530










i. https :// github . com / mclopez - uma / GLORIA _ RTSCommon . git ii.https :// github . com / mclopez - uma / GLORIA _ RTSInteractiveCommon . git iii.https :// github . com / mclopez - uma / GLORIA _ RTSInteractiveRTS 2

b. Repositories for any generic telescope:i. https :// github . com / mclopez - uma / GLORIA _ RTSCommon . git ii.https :// github . com / mclopez - uma / GLORIA _ RTSInteractiveCommon . git iii.https :// github . com / mclopez - uma / GLORIA _ RTSInteractiveGEN . git

Important notice: in case of generic telescope user/telescope owner has to implement device drivers (Java classes/interfaces). Following text assumes RTS2 driven telescope. Minimal configuration of RTS2 system is Mount, Camera, Cupola (Dome) and Executor.

Configuration files

RTD_RTS2/config/rt_config.properties

Configuration file is self explanatory. Commented sections follows:

a) general informations

########################### [MANDATORY] RTS name. ###########################rts_name=<name of the telescope>rts_longitude=<telescope longitude>rts_latitude=<telescope latitude>

b) device discoverer

################################################################################# [MANDATORY] Device Discoverer. Implements: eu.gloria.rtc.DeviceDiscoverer… #################################################################################device.discoverer.provider=eu.gloria.rts2.rtd.DeviceDiscoverer

#developmentdevice.discoverer.config.device.list.xsd=<path to gloria_rti_environment_config_device.xsd>device.discoverer.config.device.list.xml=<path to environment_device_list.xml>

c) UUID generator

########################################## [MANDATORY] UUID generator provider. ##########################################uuid.generator.provider=eu.gloria.tools.uuid.BasedOnTimeUUIDGeneratoruuid.generator.rts.id=1

d) external executor

RTS2 has to be interrupted before GLORIA system takes a control. This is configuration of the proper implementation.


https://github.com/mclopez-uma/GLORIA_RTSInteractiveGEN.git















https://github.com/mclopez-uma/GLORIA_RTSInteractiveCommon.git















https://github.com/mclopez-uma/GLORIA_RTSCommon.git















https://github.com/mclopez-uma/GLORIA_RTSInteractiveRTS2













































#################################### External executor configuration ####################################external.executor.interrupter.enable=true# Executor interrupter implementationexternal.executor.interrupter.provider=eu.gloria.rts2.rtc.RTS2ExternalInterrupter

e) connection parameters

Be sure, that your host has properly defined localhost alias, otherwise use 127.0.0.1

######################################## Connection parameters to repository ########################################proxyHost=localhostproxyPort=8080proxyAppName=RTIDBproxyUser=gloria_userproxyPw=12345proxyHttps=falseproxyCertRep=<path to certificate, if https used>

RTD_RTS2/config/environment_device_list.xml

For each device in the telescope, there has to be a device node with the following information:

<device><shortName>C0</shortName> → Device identifier<version>1.0</version> → Version of the developed RTD<description>Camera</description> → Owner description<type>CCD</type> → Device type as in eu.gloria.rt.entity.device.DeviceType.java<subtype>NONE</subtype> → Device subtype for using in rtd_gen_discovery.ini

</device>

If in the RTD implementation it is needed any information that can not be provided establishing communication with the device and has to be set in advance, the device property node can be used:

<device><shortName>dome</shortName><version>1.0</version><description>DOME</description><type>DOME</type><subtype>NONE</subtype><property>

<name>IP</name> → Property identifier <basicType>STRING</basicType> → If a basic type property is used (See below) <complexType>NONE</complexType> → If a complex type property is used (See below) <description>IP info</description> → Property description <mandatory>false</mandatory> → Mandatory field <defaultValue>161.72.128.11</defaultValue> → Property value <readonly>false</readonly> → Read/write field

</property>



</device>

Basic types: STRING, INTEGER, TIME, DOUBLE, FLOAT, BOOL, SELECTION, LONGINT

Complex types: MMAX, NONE, RADEC, ALTAZ, STAT, RECTANGLE, ARRAY

RTD_RTS2/config/rtd_discovery.ini

This file contains information about the RTD/RTDI_PROXY implementation. When RTD implementation is used, # RTD LOCAL section has to be uncommented and # RTD REMOTE section has to be commented. Follows minimal RTS2 dummy configuration:

#################################### DEVICE TYPE vs IMPLEMENTACION : ####################################

[CCD]Dummy = eu.gloria.rts2.rtd.CameraRTD

[DOME]Dummy = eu.gloria.rts2.rtd.DomeRTD

[MOUNT]Dummy = eu.gloria.rts2.rtd.MountRTD

Database creation

1. Log into mysql with root privileges. The root password will be required.

$ mysql -u root -p

2. Create the gloria database.

$ mysql> CREATE DATABASE gloria;

3. Create the gloria user

$ mysql> GRANT ALL PRIVILEGES ON gloria.* TO gloria_user IDENTIFIED BY

'gloria_pass';

The user and password created in this step have to be the same as in file persistence.xml in RTpersistence project (see below).

4. Make sure the database you are using is the one created above.

$ mysql> use gloria

5. Import the database schema. The schema is in RTS_INTERACTIVE.sql file in InteractiveDB project.

$ mysql> \. RTS_SCH.sql

The file persistence.xml in RTPersistence project has to include the information about the database user and password:

<property name="hibernate.connection.password" value=""/>

<property name="hibernate.connection.username" value=""/>



Building and deployment

For successful build of the RTI interface is necessary to properly configure RTI/build.xml. On the beginning of the file should line similar to this:

<project name="RTI" default="RTD_GENERIC_DEV" >

Value of default property must be corresponds to target section it the config file:

<target name="RTD_GENERIC_DEV" depends="..." >

...

</target>

In target section are described paths to config files.

After successfull build (default Eclipse setting is “build automaticaly”, if not, use Project → Build project while RTI project is active). In directory RTI/config should appear config files from RTD_RTS2/config (one can use F5 to refresh).

After build user should be able to generate WAR files to deploy in Tomcat environment. To generate WAR files one can right click on the project (RTI, …), select Export and then WAR (in the Web bookmark). Three WAR files have to be generated and deployed: RTI.war, RTIDB.war and RTIDBRepository.war.

GLORIA recommends Tomcat 7.0.23 for the production environment. Please make sure that user and password for gloria user are the same as in rt_config.properties file. Here is an example of tomcat-users.xml

<role rolename="manager-gui"/>

<role rolename="admin-gui"/>

<role rolename="gloria-system"/>

<user username="gloria_user" password="YYY" roles="gloria-system"/>

<user username="administrator" password="XXX" roles="manager-gui,admin-gui"/>

where:

● YYY → Password used by GLORIA to connect to the RTS.● XXX → Password used by the telescope owner to manage the applications in Tomcat.● gloria-system → Role of the RTI user.● admin-gui → Role of the administration module user.● manager-gui → Role of the administration module user.● administrator → administration module user.● gloria_user →RTI/RTIDB/RTIDBRepository web service user.



Figure 1: Tomcat manager wih RTI, RTDB and RTIDBrepository deployed

Aditional Software

In order to use libnova with GLORIA software it is necessary to have Java Native Interface compiled:

1. Create the folder: $ mkdir /usr/share/gloria/rts/libNovaJNI/

2. Save in the previous folder the fileseu_gloria_rt_catalogue_libnova_LibNovaJNI.cpp

eu_gloria_rt_catalogue_libnova_LibNovaJNI.h

3. Compile:$ g++ "-I/usr/lib/jvm/java-6-openjdk/include" -g -c -Wall -fPIC

eu_gloria_rt_catalogue_libnova_LibNovaJNI.cpp -o

eu_gloria_rt_catalogue_libnova_LibNovaJNI.o -fpermissive

4. Library generation:$ ld -G *.o -o eu_gloria_rt_catalogue_libnova_LibNovaJNI.so -lnova [-

lgcj]

[-lgcj] is optional, see below.5. Possible problems:

java.lang.UnsatisfiedLinkError undefined symbol: __gcj_personality _v0● Install: sudo apt-get install gcj● Create a soft link at: /usr/lib/libgcj.so a /usr/lib/libgcj.so.10.0.0.06. Create a softlink in /usr/lib folder:

$ sudo ln -s

/usr/share/gloria/rts/libNovaJNI/eu_gloria_rt_catalogue_libnova_LibNovaJNI.so

libNovaJNI.so

2.3 RTIsch Batch Mode

RTIsch solution for batch mode can be found in Github repositories:c. Repositories for ACP telescopes:



i. https :// github . com / mclopez - uma / GLORIA _ RTSCommon . git ii.https :// github . com / mclopez - uma / GLORIA _ RTSBatchCommon . git iii.https :// github . com / mclopez - uma / GLORIA _ RTSBatchACPTololo

d. Repositories for any generic telescope:i. https :// github . com / mclopez - uma / GLORIA _ RTSCommon . git ii.https :// github . com / mclopez - uma / GLORIA _ RTSBatchCommon . git iii.https :// github . com / mclopez - uma / GLORIA _ RTSBatchGEN . git

In the batch mode it is necessary to store states of observing plans offered from central GLORIA scheduler as well as any other information. One should follow steps to create MySQL database:

6. Log into mysql with root privileges. The root password will be required.

$ mysql -u root -p

7. Create the gloria database.

$ mysql> CREATE DATABASE gloria;

8. Create the gloria user

$ mysql> GRANT ALL PRIVILEGES ON gloria.* TO gloria_user IDENTIFIED BY

'gloria_pass';

The user and password created in this step have to be the same as in file persistence.xml in RTpersistence project (see below).

9. Make sure the database you are using is the one created above.

$ mysql> use gloria

10. Import the database schema. The schema is in RTS_SCH.sql file in BatchDB project.

$ mysql> \. RTS_SCH.sql

The file persistence.xml in RTPersistence project has to include the information about the database user and password:

<property name="hibernate.connection.password" value=""/>

<property name="hibernate.connection.username" value=""/>

Once dababase is created, some telescope specific values has to be inserted:

WorkAdvertisementManager information (idTask = 1):

1. How many days (x) constraints will be evaluated.

$ mysql> insert into gloria.TaskProperty (idtask, name, value, type) values

(1, 'days_ahead', <telescope specific value> , 0);

2. Maximum OP per day (y)


(1, 'op_per_day', <telescope specific value>, 0);


https://github.com/mclopez-uma/GLORIA_RTSBatchGEN.git















https://github.com/mclopez-uma/GLORIA_RTSBatchCommon.git






























https://github.com/mclopez-uma/GLORIA_RTSBatchACPTololo












































3. Observatory localization


(1, 'obs_altitude', <telescope specific value>, 0);


(1, 'obs_latitude', <telescope specific value>, 0);


(1, 'obs_longitude', <telescope specific value>, 0);

WorkOffshoreRetriever information (idTask = 2):

4. IP/port and project name where RTIDB project runs.$ mysql> insert into gloria.TaskProperty (idtask, name, value, type) values

(2, 'proxyHost', <telescope IP> , 0);


(2, 'proxyPort', <telescope port> , 0);


(2, 'proxyAppName', 'RTIDB', 0);

5. Gloria user and password (see rti_config.properties file).


(2, 'proxyUser', <username>, 0);


(2, 'proxyPw', <password>, 0);

6. Https use


(2, 'proxyHttps', <true/false>, 0);


(2, 'proxyCertRep', <path to certificate>, 0);

Any other information needed to the local implementation may be included in WorkOffshoreRetreiver task properties.

WorkOffshorePublisher information (idTask = 3):

Any other information needed to the local implementation may be included in WorkOffshorePublisher task properties.

The file rti_config.properties in RTPSch project has to include the information about the GLORIA user and password. The values have to be the same as the ones in the database.

login.ws.method.user=

login.ws.method.pw=



Configuration is very similar to Interactive mode. Wars to be builded and deployed: RTIDB, RTIDBRepository, RTISch and RTOPManager.

Figure 2: Tomcat manager with RTIsch packages deployed

2.4 Luiza framework

Luiza framework package can be downloaded from GLORIA svn repository at http :// sourceforge . net / projects / gloriaproject / . The whole framework uses Doxygen package for creating user documentation, which is available at the dedicated web page http :// hep . fuw . edu . pl / gloria / luiza / . This documentation includes also detailed description of the installation procedure as well as system and software requirements, as shown in the figure below (http://hep.fuw.edu.pl/gloria/luiza/luiza_install.html):


http://hep.fuw.edu.pl/gloria/luiza/luiza_install.html

http://hep.fuw.edu.pl/gloria/luiza/














http://sourceforge.net/projects/gloriaproject/











Figure 3: How to install Luiza framework

In particular, additional software packages, which are required for full functionality of the Luiza framework are listed there. After installing the required packages and downloading the sources, the framework is build by standard ‘make’ command. In addition to the main Luiza program and processor libraries (different tools are linked to the main program at run time, as shared libraries), graphic interface for Luiza steering file preparation (LuizaGUI) as well as full Doxygen documentation in html and pdf are created. Running analysis jobs based on the Luiza framework requires setting properly working environment. Example scripts with definitions of needed environmental variables are also included in the distribution. User needs only to update them to fit his local installation (eg. paths to the software and library locations). Moreover, documentation created using Doxygen includes detailed description of all implemented analysis tools, their input and output data streams and parameters, which can be set by user to control their performance. These parameters have to be included in the job steering file, which can be created and edited by using LuizaGUI or any text editor. Example of class description available in Luiza documentation is shown below.



Figure 4: Example of documentation. Class to read a FITS image

3. SUMMARY

In addition to the software documentation and written installation instructions, which are provided with each GLORIA software package, users can always contact GLORIA software developers directly to obtain additional information and support. In fact, we assume that we will assist GLORIA users, and in particular telescope owners in installation of the GLORIA software components. Based on the collected experience installation instructions will be extended in the future.
