Recent changes to CapsisBridgeServer

CapsisBridgeServer modified by Jean-Francois Lavoie

Jean-Francois Lavoie — Wed, 01 Sep 2021 20:13:23 -0000

--- v13
+++ v14
@@ -14,10 +14,12 @@

 ## Building
 ### Choosing between lightweight and full builds
+
 CAPSISBridge has two main purposes : 
     1. Exposing models and simulation methods to allow accessing CAPSIS and its forest growth simulation capabilities.   This mode is called *full build* mode and requires CAPSIS as a dependency. 
-    2. Exposing metamodel related features only to allow get metamodel predictions using pre-fitted metamodels.  This mode is called *lightweight* build and does not require CAPSIS, but only the REpicea.jar library.    
-    Choosing between the two building modes can be set by setting the following properties in the gradle.properties file located in the root folder :
+    2. Exposing metamodel related features only to allow get metamodel predictions using pre-fitted metamodels.  This mode is called *lightweight* build and does not require CAPSIS, but only the REpicea.jar library.     
+
+Choosing between the two building modes can be set by setting the following properties in the gradle.properties file located in the root folder :
 *     *buildUsingCapsis* : set this to "true" to enable full builds using CAPSIS, and set to "false" to enable lightweight builds using REpicea.  Default value is "false".
 *     *capsisPath* : the location of the CAPSIS folder to build with.  Default value is "..\..\capsis".
 *     *repiceaPath* : the location of the CAPSIS folder to build with.  Default value is "..\..\externallibraries".

CapsisBridgeServer modified by Jean-Francois Lavoie

Jean-Francois Lavoie — Wed, 01 Sep 2021 20:11:50 -0000

--- v12
+++ v13
@@ -13,6 +13,15 @@
 An access to the CAPSIS repository is also required to build the CAPSIS Bridge Server.

 ## Building
+### Choosing between lightweight and full builds
+CAPSISBridge has two main purposes : 
+    1. Exposing models and simulation methods to allow accessing CAPSIS and its forest growth simulation capabilities.   This mode is called *full build* mode and requires CAPSIS as a dependency. 
+    2. Exposing metamodel related features only to allow get metamodel predictions using pre-fitted metamodels.  This mode is called *lightweight* build and does not require CAPSIS, but only the REpicea.jar library.    
+    Choosing between the two building modes can be set by setting the following properties in the gradle.properties file located in the root folder :
+*     *buildUsingCapsis* : set this to "true" to enable full builds using CAPSIS, and set to "false" to enable lightweight builds using REpicea.  Default value is "false".
+*     *capsisPath* : the location of the CAPSIS folder to build with.  Default value is "..\..\capsis".
+*     *repiceaPath* : the location of the CAPSIS folder to build with.  Default value is "..\..\externallibraries".
+
 ### Eclipse
 Building on Eclipse is done through the Buildship plugin that allows Gradle integration.
 1. Checkout the SVN repository into the desired local folder

CapsisBridgeServer modified by Mathieu Fortin

Mathieu Fortin — Wed, 17 Mar 2021 14:15:21 -0000

--- v11
+++ v12
@@ -30,7 +30,7 @@

 The ShadowJar Gradle task will produce the jar file "capsisBridgeServer-all.jar" in the root path of the CAPSIS project. **IMPORTANT: the Gradle project assumes that the Capsis folder is found at this relative location:  ../../capsis . If the Capsis projet is located somewhere else, this relative location must be changed in order to properly compile the Gradle project. The property that sets the relative location of the Capsis folder is called "capsispath" and it can be changed in the "gradle.properties" file found at the root of the Gradle project.**  

-## Packaging the CapsisBridge server
+## Packaging 
 The CapsisBridge server can be packaged as follows:
 1. Open a command line
 2. Go to the root of the Capsis project
@@ -43,3 +43,23 @@
 ~~~
 > java -jar capsis-bridge-setup.jar
 ~~~
+
+## Running an instance of CapsisBridge server
+Once the server has been installed, it can be started using a command line:
+~~~
+java -jar capsisBridgeServer-all.jar p=50001
+~~~
+Parameter p indicates the port number. Several instances can be started if they listen to different ports. When a particular instance is started, the following message should appear in the console:
+~~~
+Capsis 4.2.6-16940 with pilot capsis.script.Pilot: correct boot at 17 Mar 2021 10:13:53 EDT
+Working dir: C:\Users\matforti\Documents\4_GrowthSimulators\CapsisBridgeServer
+Updating settings...
+Running CAPSIS version 4.2.6-16940
+Authors: Jean-Francois Lavoie and Mathieu Fortin
+For the Canadian Forest Service
+Copyright (c) Her Majesty the Queen in right of Canada
+This software uses the gRPC library located at https://www.grpc.io/
+which is licensed under the Apache 2.0 license available at
+https://www.apache.org/licenses/LICENSE-2.0
+2021-03-17 10:13:54 INFO Server started, listening on 50001
+~~~

CapsisBridgeServer modified by Mathieu Fortin

Mathieu Fortin — Wed, 17 Mar 2021 13:25:20 -0000

--- v10
+++ v11
@@ -36,10 +36,10 @@
 2. Go to the root of the Capsis project
 3. Enter the following command: 
 ~~~
-ant clean installer-bridge -Dmodules="quebecmrnf/**,artemis/**"
+> ant clean installer-bridge -Dmodules="quebecmrnf/**,artemis/**"
 ~~~

 The ant script will create a package called "capsis-bridge-setup.jar" in the root path of the Capsis project. This jar file is a standalone installer of the Capsis project. Double-clicking on the file will start the installation of the CapsisBridge server with only one available model: Artemis. If the double-clicking does not work, the installation can be triggered through a command line:
 ~~~
-java -jar capsis-bridge-setup.jar
+> java -jar capsis-bridge-setup.jar
 ~~~

CapsisBridgeServer modified by Mathieu Fortin

Mathieu Fortin — Wed, 17 Mar 2021 13:25:00 -0000

--- v9
+++ v10
@@ -39,4 +39,7 @@
 ant clean installer-bridge -Dmodules="quebecmrnf/**,artemis/**"
 ~~~

-The ant script will create a package called "capsis-bridge-setup.jar" in the root path of the Capsis project. This jar file is a standalone installer of the Capsis project. Double-clicking on the file will start the installation of the CapsisBridge server with only one available model: Artemis. 
+The ant script will create a package called "capsis-bridge-setup.jar" in the root path of the Capsis project. This jar file is a standalone installer of the Capsis project. Double-clicking on the file will start the installation of the CapsisBridge server with only one available model: Artemis. If the double-clicking does not work, the installation can be triggered through a command line:
+~~~
+java -jar capsis-bridge-setup.jar
+~~~

CapsisBridgeServer modified by Mathieu Fortin

Mathieu Fortin — Wed, 17 Mar 2021 13:23:09 -0000

--- v8
+++ v9
@@ -39,4 +39,4 @@
 ant clean installer-bridge -Dmodules="quebecmrnf/**,artemis/**"
 ~~~

-The ant script will create a package called "capsis-setup.jar" in the root path of the Capsis project. This jar file is a standalone installer of the Capsis project. Double-clicking on the file will start the installation of the CapsisBridge server with only one available model: Artemis. 
+The ant script will create a package called "capsis-bridge-setup.jar" in the root path of the Capsis project. This jar file is a standalone installer of the Capsis project. Double-clicking on the file will start the installation of the CapsisBridge server with only one available model: Artemis.

CapsisBridgeServer modified by Mathieu Fortin

Mathieu Fortin — Wed, 17 Mar 2021 13:22:34 -0000

--- v7
+++ v8
@@ -1,15 +1,19 @@
-# Overview
+# CapsisBridge server
+
+[TOC]
+
+## Overview
 This module uses gRPC for java to offer RPC Methods allowing access to the a subset of the Capsis simulation platform models.  It also uses the Gradle build system (https://gradle.org/).  It includes two different packages : 
         1. CapsisBridgeService which provides the API service for Capsis access
         2. CapsisBridgeClient which is the API to be used by JAVA client applications to connect to CapsisBridgeService and abstract gRPC

-# Requisites
+## Requisites
 Java 1.8 is required and the project can be built using either Eclipse or IntelliJ Idea. 
 The Gradle build system requires the "Buildship" plugin for Eclipse (https://projects.eclipse.org/projects/tools.buildship).
 An access to the CAPSIS repository is also required to build the CAPSIS Bridge Server.

-# Building
-## Eclipse
+## Building
+### Eclipse
 Building on Eclipse is done through the Buildship plugin that allows Gradle integration.
 1. Checkout the SVN repository into the desired local folder
 2. Under File menu, choose "Import" to import a new project
@@ -18,7 +22,7 @@
 5. Launch the "ShadowJar" Gradle task using the "Gradle Tasks" tab showing in the lower pane window to build **CapsisBridgeService**
 6. Launch the "InstallDist" Gradle task using the "Gradle Tasks" tab showing in the lower pane window to build **CapsisBridgeClient**

-##IntelliJ IDEA
+### IntelliJ IDEA
 1. Checkout the SVN repository into the desired local folder
 2. Use "Open" file menu to open the root folder where the code is located
 3. Launch the "ShadowJar" Gradle task using the "Gradle Tasks" tab showing in the lower pane window to build **CapsisBridgeService**
@@ -26,7 +30,7 @@

 The ShadowJar Gradle task will produce the jar file "capsisBridgeServer-all.jar" in the root path of the CAPSIS project. **IMPORTANT: the Gradle project assumes that the Capsis folder is found at this relative location:  ../../capsis . If the Capsis projet is located somewhere else, this relative location must be changed in order to properly compile the Gradle project. The property that sets the relative location of the Capsis folder is called "capsispath" and it can be changed in the "gradle.properties" file found at the root of the Gradle project.**  

-# Packaging the CapsisBridge server
+## Packaging the CapsisBridge server
 The CapsisBridge server can be packaged as follows:
 1. Open a command line
 2. Go to the root of the Capsis project

CapsisBridgeServer modified by Mathieu Fortin

Mathieu Fortin — Wed, 17 Mar 2021 13:21:34 -0000

--- v6
+++ v7
@@ -24,4 +24,15 @@
 3. Launch the "ShadowJar" Gradle task using the "Gradle Tasks" tab showing in the lower pane window to build **CapsisBridgeService**
 4. Launch the "InstallDist" Gradle task using the "Gradle Tasks" tab showing in the lower pane window to build **CapsisBridgeClient**

-The ShadowJar Gradle task will produce a jar in the root path of the CAPSIS project. **IMPORTANT: the Gradle project assumes that the Capsis folder is found at this relative location:  ../../capsis . If the Capsis projet is located somewhere else, this relative location must be changed in order to properly compile the Gradle project. The property that sets the relative location of the Capsis folder is called "capsispath" and it can be changed in the "gradle.properties" file found at the root of the Gradle project.**  
+The ShadowJar Gradle task will produce the jar file "capsisBridgeServer-all.jar" in the root path of the CAPSIS project. **IMPORTANT: the Gradle project assumes that the Capsis folder is found at this relative location:  ../../capsis . If the Capsis projet is located somewhere else, this relative location must be changed in order to properly compile the Gradle project. The property that sets the relative location of the Capsis folder is called "capsispath" and it can be changed in the "gradle.properties" file found at the root of the Gradle project.**  
+
+# Packaging the CapsisBridge server
+The CapsisBridge server can be packaged as follows:
+1. Open a command line
+2. Go to the root of the Capsis project
+3. Enter the following command: 
+~~~
+ant clean installer-bridge -Dmodules="quebecmrnf/**,artemis/**"
+~~~
+
+The ant script will create a package called "capsis-setup.jar" in the root path of the Capsis project. This jar file is a standalone installer of the Capsis project. Double-clicking on the file will start the installation of the CapsisBridge server with only one available model: Artemis.

CapsisBridgeServer modified by Mathieu Fortin

Mathieu Fortin — Wed, 17 Mar 2021 13:10:53 -0000

--- v5
+++ v6
@@ -24,4 +24,4 @@
 3. Launch the "ShadowJar" Gradle task using the "Gradle Tasks" tab showing in the lower pane window to build **CapsisBridgeService**
 4. Launch the "InstallDist" Gradle task using the "Gradle Tasks" tab showing in the lower pane window to build **CapsisBridgeClient**

-The ShadowJar Gradle task will produce a jar in the root path of the CAPSIS project. **IMPORTANT: the Gradle project assumes that the capsis folder is found at this relative location:  ../../capsis . Should it not be the case, this relative location must be changed in order to properly compile the Gradle project. The property that sets the relative location of the capsis folder is called "capsispath" and it can be changed in the "gradle.properties" file found at the root of the Gradle project.**  
+The ShadowJar Gradle task will produce a jar in the root path of the CAPSIS project. **IMPORTANT: the Gradle project assumes that the Capsis folder is found at this relative location:  ../../capsis . If the Capsis projet is located somewhere else, this relative location must be changed in order to properly compile the Gradle project. The property that sets the relative location of the Capsis folder is called "capsispath" and it can be changed in the "gradle.properties" file found at the root of the Gradle project.**

CapsisBridgeServer modified by Mathieu Fortin

Mathieu Fortin — Wed, 17 Mar 2021 13:09:58 -0000

--- v4
+++ v5
@@ -24,4 +24,4 @@
 3. Launch the "ShadowJar" Gradle task using the "Gradle Tasks" tab showing in the lower pane window to build **CapsisBridgeService**
 4. Launch the "InstallDist" Gradle task using the "Gradle Tasks" tab showing in the lower pane window to build **CapsisBridgeClient**

-The ShadowJar Gradle task will produce a jar in the root path of the CAPSIS project. 
+The ShadowJar Gradle task will produce a jar in the root path of the CAPSIS project. **IMPORTANT: the Gradle project assumes that the capsis folder is found at this relative location:  ../../capsis . Should it not be the case, this relative location must be changed in order to properly compile the Gradle project. The property that sets the relative location of the capsis folder is called "capsispath" and it can be changed in the "gradle.properties" file found at the root of the Gradle project.**