Introduction

DOME is composed of two parts: a Client and a Server. The DOME Client is used to build models, deploy them to the Server, run models, and manage the Server. The DOME Server is where the models live and are executed. You can use the DOME Client to log in to a Server you host locally on your machine (useful for testing that a model works) or a Server that is hosted remotely.

What do you need to launch?

If you are walking through the tutorials for the first time, you will need to launch a Client now. You will need a Server later in the tutorials (we'll tell you when), or you can launch both now.

If you only plan to create a model, but not deploy it to test it, you only need the Client. If you plan to test your model on a Server, you will need to launch your own local Server or have credentials to log in to a remote Server.

Instructions for Installing and Launching the DOME Client

The following tools are dependencies for setting up and running a local DOME instance.

• GIT
• https://git-scm.com/
• Git is a free and open source distributed version control system designed to handle everything from small to very large projects with speed and efficiency.
• https://git-scm.com/downloads – download instructions for your system
• install git using the following command: sudo apt-get install git
• GIT to download the code repository:
  • git clone https://github.com/dmc-uilabs/dmcdome

• JAVA

  • https://www.java.com/en/
  • Java is a general-purpose computer programming language that is concurrent, class-based, object-oriented, and specifically designed to have as few implementation dependencies as possible.
  • https://www.java.com/en/download/ – download instructions for your system
  • JAVA to run the code
• ANT
  • https://ant.apache.org/
  • Apache Ant is a Java library and command-line tool whose mission is to drive processes described in build files as targets and extension points dependent upon each other. The main known usage of Ant is the build of Java applications. Ant supplies a number of built-in tasks allowing to compile, assemble, test and run Java applications. Ant can also be used effectively to build non Java applications, for instance C or C++ applications. More generally, Ant can be used to pilot any type of process which can be described in terms of targets and tasks.
  • https://ant.apache.org/bindownload.cgi  – download instructions for your system
  1. First download the apache ant library (use documentation above as reference and extract)
  2. sudo apt-get install ant
  3. which ant
  1. copy the resulting directory
  4. In your Linux machine's home directory run: sudo nano .bashrc and add the following lines
     1. export ANT_OPTS="-Xmx256M"
     2. export ANT_HOME="DIRECTORY WHERE ANT IS INSTALLED"

  5. Go to your local DOME git directory

  6. sudo ant compile-client

  7. sudo ant dist-client

  8. sudo ant run-client

 Individual installation instructions can be found on the respective project websites for your specific platform. Example of Java specific instructions offered below.

Open a Terminal window (Mac/Linux) or a Command Prompt or PowerShell window (Windows).

The kernel will run on any platform supporting Java Virtual Machine (JVM) version 1.6.0.45 or higher.

You can test the version of Java with the command:

$ java -version   (Mac/Linux)

> java -version   (Windows)

If the version number is lower than 1.6.0.45, Windows & Mac users, please download a new Java (TM) SE Runtime Environment from https://java.com/en/download/. Linux users can install the openjdk with a command such as "sudo apt-get install openjdk-7-jdk" (tailored to your distribution).

Mac Issue: Does not run from the directory. Mac runs from the home directory. The .sh path assumes you start in BIN directory.  <Not sure what to say here – we need to fix the script>

For Windows OS users, if you upgrade the Java version, change the java_home and CLASSPATH in the System Environment variables to point to the updated java folder, logout, and log back in. Note: the System Variable may be "path". To change the system environment variables, follow the below steps. From the desktop, right-click My Computer and click Properties. In the Advanced section, click the Environment Variables button. Note: If you are uncertain where the updated java folder is, check: "c:\Program Files (x86)\Java\".

Once you are sure about having java 1.6.0.45 or higher and that git as well as ant are properly installed do the following:

1. Download or clone the latest DOME code base from our repositories that can be found on  Bitbucket at the following location:

https://github.com/dmc-uilabs/dmcdome

2. This step might take several minutes.

3. Unzip/extract the file in Windows. Mac will download and extract the files automatically. In Linux, execute the following commands:

cd ~/Downloads
mkdir ~/dome
# this directory placement is convenient, but not necessary
unzip domeInstall-[date].zip -d ~/dome
# if unzip is not already installed: $ sudo apt-get install unzip

Building DOME Client

DOME is built using Ant.

Before executing the below commands, navigate to the /dome directory you created above.

To build the DOME client, execute the command:

ant dist-client

Running DOME Client

DOME can also be run, after it is built, using Ant.

To run the DOME client, execute the command:

ant run-client

When the DOME3 Copyright pop up opens, accept the Terms and Conditions.

At this point, the DOME Client will open. Do not close the Terminal, Command Prompt, or PowerShell window.

The DOME Client is the thin toolbar shown in Figure 1. At the right of the bar you see Build to indicate the mode. The four modes are Build, Deploy, Run, and Server. The rest of the tool bar changes automatically to reflect the mode.

Figure 1. DOME Window

Build is used to build a model, enter variables, and build the interface.

Deploy is used to deploy a model interface to the server so that other users can access it.

Run is used to run a model interface found on the server.

Server is used to manage the server.

Instructions for Installing and Launching the DOME Server

Building the DOME Server

To build the DOME server, execute the command:

ant dist-server

Running the DOME Server

DOME can also be run, after it is built, using Ant.

To run the DOME Server, execute the command:

ant run-server

If you do not have a remote DOME server available to log in to, you can set up a local server for testing purposes.

You will see various output appear; one of the last lines will be "DomeServer started on port [number] at [timestamp]". Note the port number to log in with later.

Logging into the DOME Server

Using the DOME client one can select the run option and create a new connection to the DOME server. The default credentials for local login are:

• User:   ceed
• Password:  ceed
• Server Url:  localhost:7795

Consult our other tutorials for more information on creating and running local dome applications.