Difference between revisions of "Hemera:Install"

From HemeraBook
Jump to: navigation, search
Line 1: Line 1:
=Hemera installation=
+
=Prepare a Workspace=
==Prepare a Workspace==
+
 
You should begin preparing a workspace with enough space.<br />
 
You should begin preparing a workspace with enough space.<br />
 
Let's call it '''''[HEMERA_ROOT_PATH]'''''.
 
Let's call it '''''[HEMERA_ROOT_PATH]'''''.
  
==Get the source code==
+
<br />
===Command line===
+
=Get the source code=
 +
==Command line==
 
cd '''''[HEMERA_ROOT_PATH]'''''<br/>
 
cd '''''[HEMERA_ROOT_PATH]'''''<br/>
 
svn co https://hemerais.svn.sourceforge.net/svnroot/hemerais/trunk/hemera
 
svn co https://hemerais.svn.sourceforge.net/svnroot/hemerais/trunk/hemera
  
===Under Eclipse (or other IDE)===
+
==Under Eclipse (or other IDE)==
 
Add '''https://hemerais.svn.sourceforge.net/svnroot/hemerais''' as a new repository URL.<br />
 
Add '''https://hemerais.svn.sourceforge.net/svnroot/hemerais''' as a new repository URL.<br />
 
Checkout following projects, from trunk or wanted branch: ''hemera''
 
Checkout following projects, from trunk or wanted branch: ''hemera''
  
==Setup==
+
<br />
===Update Operating System===
+
=Setup=
 +
==Update Operating System==
 
To setup Hemera (e.g. improving accessibility of Hemera binaries/scripts), launch as root superuser:<br />
 
To setup Hemera (e.g. improving accessibility of Hemera binaries/scripts), launch as root superuser:<br />
 
'''[HEMERA_ROOT_PATH]/scripts/setupHemera.sh'''
 
'''[HEMERA_ROOT_PATH]/scripts/setupHemera.sh'''
  
<br />
+
==Configure==
===Configure===
+
 
To help configuring the whole of Hemera, a global configuration file system has been created.<br />
 
To help configuring the whole of Hemera, a global configuration file system has been created.<br />
 
<br />
 
<br />
Line 25: Line 25:
 
For each tool, you can either update the corresponding configuration element (specifying an absolute path, or a path relative to [HEMERA_ROOT_PATH]) or ensure it is available from the PATH environment variable (specifying only the file name of the tool).
 
For each tool, you can either update the corresponding configuration element (specifying an absolute path, or a path relative to [HEMERA_ROOT_PATH]) or ensure it is available from the PATH environment variable (specifying only the file name of the tool).
  
<br />
+
==Environment==
===Environment===
+
 
Hemera java pieces need:<br />
 
Hemera java pieces need:<br />
 
- a version of [http://www.oracle.com/technetwork/java/index.html Java Development Kit] (jdk6 or newer)<br />
 
- a version of [http://www.oracle.com/technetwork/java/index.html Java Development Kit] (jdk6 or newer)<br />
Line 34: Line 33:
 
     or update '''environment.java.home''' and '''environment.ant.home''' in your Hemera configuration file.
 
     or update '''environment.java.home''' and '''environment.ant.home''' in your Hemera configuration file.
  
<br />
+
=Java properties=
==Java properties==
+
 
If you want launching Hemera java piece (like the Java sound player) in an IDE (e.g. Eclipse), you should specify the following properties:<br />
 
If you want launching Hemera java piece (like the Java sound player) in an IDE (e.g. Eclipse), you should specify the following properties:<br />
 
- '''java.system.class.loader''' to define the Hemera specific classloader which loads the properties file automatically<br />
 
- '''java.system.class.loader''' to define the Hemera specific classloader which loads the properties file automatically<br />
Line 50: Line 48:
  
 
<br />
 
<br />
==Third-Party tools availability==
+
=Third-Party tools availability=
 
See [[Install third-party tools]].<br />
 
See [[Install third-party tools]].<br />
 
Each third-party tool binary path, and data file path are checked when using corresponding core module.<br />
 
Each third-party tool binary path, and data file path are checked when using corresponding core module.<br />
 
A specific error message will be given in case of failure.
 
A specific error message will be given in case of failure.

Revision as of 07:38, 16 September 2010

Prepare a Workspace

You should begin preparing a workspace with enough space.
Let's call it [HEMERA_ROOT_PATH].


Get the source code

Command line

cd [HEMERA_ROOT_PATH]
svn co https://hemerais.svn.sourceforge.net/svnroot/hemerais/trunk/hemera

Under Eclipse (or other IDE)

Add https://hemerais.svn.sourceforge.net/svnroot/hemerais as a new repository URL.
Checkout following projects, from trunk or wanted branch: hemera


Setup

Update Operating System

To setup Hemera (e.g. improving accessibility of Hemera binaries/scripts), launch as root superuser:
[HEMERA_ROOT_PATH]/scripts/setupHemera.sh

Configure

To help configuring the whole of Hemera, a global configuration file system has been created.

Copy [HEMERA_ROOT_PATH]/config/hemera.conf.sample to [HEMERA_ROOT_PATH]/config/hemera.conf and adapt it to your configuration.
For each tool, you can either update the corresponding configuration element (specifying an absolute path, or a path relative to [HEMERA_ROOT_PATH]) or ensure it is available from the PATH environment variable (specifying only the file name of the tool).

Environment

Hemera java pieces need:
- a version of Java Development Kit (jdk6 or newer)
- Apache Ant.

-> after installation, you should either update your environment variables JAVA_HOME and ANT_HOME,
   or update environment.java.home and environment.ant.home in your Hemera configuration file.

Java properties

If you want launching Hemera java piece (like the Java sound player) in an IDE (e.g. Eclipse), you should specify the following properties:
- java.system.class.loader to define the Hemera specific classloader which loads the properties file automatically
- hemera.property.file to define the Hemera properties file

For instance (with Eclipse ${workspace_loc} variable):

-Djava.system.class.loader=hemera.HemeraClassLoader -Dhemera.property.file=${workspace_loc}/hemera/config/hemera.conf


You may use the additional properties:
- hemera.log.file to define a log file (messages will be appended to the file if it already exists)

For instance:

-Dhemera.log.file="/path/to/logFile"


Third-Party tools availability

See Install third-party tools.
Each third-party tool binary path, and data file path are checked when using corresponding core module.
A specific error message will be given in case of failure.