Quick install guide

Quick Install Guide

This guide provides basic installation instructions of JDemetra+ for users and system administrators.

System and software requirements

JDemetra+ runs on any operating systems that support the Java VM (Virtual Machine) such as Microsoft Windows, Solaris OS, Apple macOS, Ubuntu and other various Linux distributions.

JDemetra+ requires a Java SE Runtime Environment (JRE) version 8 or later to run on such as OpenJDK. You can download a free, binary distribution of the OpenJDK at one of the following provider: Zulu JDK, Adoptium, Amazon Corretto.

Guided installation

1. Download the platform-dependent installer (jdemetra-X.Y.Z-setup-PLATFORM.EXT) at:
   https://github.com/jdemetra/jdemetra-app/releases/latest
2. Run the installer and follow the instructions.

Note 1: in some cases, the installer is unable to locate the JRE.
Fortunately, it is possible to set its location explicitly by using the option --javahome
e.g. jdemetra-2.2.4-setup-windows.exe --javahome "C:\somedir\Java8"

Note 2: the installation may be blocked by your operating system.
Possible solutions: Windows (Microsoft Defender SmartScreen) and macOS (Gatekeeper).

Silent installation

1. Download the platform-dependent installer (jdemetra-X.Y.Z-setup-PLATFORM.EXT) at:
   https://github.com/jdemetra/jdemetra-app/releases/latest
2. Run the installer with the option --record in order to create an installation script.
   e.g. jdemetra-2.2.4-setup-windows.exe --record silent-install.xml
3. Run the installer with the option --silent to replay the installation with the installation script.
   e.g. jdemetra-2.2.4-setup-windows.exe --silent silent-install.xml

Manual installation

1. Download the platform-independent zip package (jdemetra-X.Y.Z-bin.zip) at:
   https://github.com/jdemetra/jdemetra-app/releases/latest
2. Extract it to any folder on your system (i.e. _DEMETRA_PATH_)
3. Create a shortcut to the executable file located in the _DEMETRA_PATH_/bin directory:
   Windows: nbdemetra64.exe
   Linux, Solaris and macOS: $ ./nbdemetra

User directory

The user directory (i.e. _USERDIR_PATH_) is the place where logs, cache and plugins are stored.
Its default location depends on your platform:

• Windows: %appdata%/.nbdemetra/dev
• Linux and Solaris: ~/.nbdemetra/dev
• macOS: ~/Library/Application Support/.nbdemetra/dev

Its location can be customized by editing the config file.

Config file

The main config file of JDemetra+ is located at _DEMETRA_PATH_/etc/nbdemetra.conf.
It can be used to customize the launch parameters of the application such as:

• *_userdir: the user directory
• jdkhome: the location of the Java runtime used to run JDemetra+ on
• default_options: any parameters passed to the Java runtime or JDemetra+ during startup such as memory configuration parameters, debugging options, fontsize, look and feel switches, ...
• extra_clusters: the paths to additional clusters separated by colons (Linux, Solaris, macOS) or semicolons (Windows)

There is also a user config file that overrides the main file and is located at _USERDIR_PATH_/etc/nbdemetra.conf.
It is useful when a user needs a specific configuration or if the user has not the permission to modify the main config.

Troubleshooting

If the launching of JDemetra+ fails, you can try the following operations:

1. Check if Java is properly installed by typing in the following command in a terminal:
   java -version
2. Check the logs in the folder _USERDIR_PATH_/var/log/
3. Clear the cache by deleting the folder _USERDIR_PATH_/var/cache/

A few tips

It is also possible to customize the startup of JDemetra+ by adding some options on the command line:

• --jdkhome: specify the path of a specific JRE
  e.g. nbdemetra64.exe --jdkhome "_JAVA_PATH_"
  e.g. nbdemetra64.exe --jdkhome %JAVA_HOME%
• --userdir: specify a custom user directory that can be used to launch several sessions at the same time
  e.g. nbdemetra64.exe --userdir "_USERDIR_PATH_"