Recent changes to CapsisBridgeRClient

CapsisBridgeRClient modified by Jean-Francois Lavoie

Jean-Francois Lavoie — Mon, 14 Feb 2022 21:32:53 -0000

--- v6
+++ v7
@@ -6,7 +6,7 @@

 1. Follow these instructions first to build the C++ library under MinGW64 : https://sourceforge.net/p/capsisbridge/wiki/Building%20on%20Microsoft%20Windows%20and%20MinGW64/ 
 2. Start RStudio and open the CapsisBridge R client project
-3. Modify the Makevars.win file into the src subfolder and set the variable CAPSISBRIDGE_INSTALLDIR to the location where the C++ library has been installed (typically the install folder under the build_mingw64 folder of the c++ lib folder).  i.e. : /w/NRCan/cpp/CapsisBridge/cppclient/build_mingw64/install
+3. Modify the Makevars.win file into the src subfolder and set the variable CAPSISBRIDGE_INSTALLDIR to the location where the C++ library has been installed (typically the install folder under the build_mingw64 folder of the c++ lib folder).  i.e. : /w/projects/cpp/CapsisBridge/cppclient/build_mingw64/install
 4. (Linux only) On Linux systems, when gRPC is installed locally, we must specify the location of the grpc installation so that the Makevars file pkg-config statement can find grpc at its dependencies, i.e. ~/.local/lib/pkgconfig using command : 
   `export PKG_CONFIG_PATH=~/.local/lib/pkgconfig`
 6. Build the package using CTRL-SHIFT-B
@@ -36,7 +36,7 @@
 Calling the CBGetStratumGroups method returns the available stratum groups in the meta-model manager instance. For example,

 ~~~R
-> CBGetStratumGroups()
+> MMGetStratumGroups()
 -------------- getStratumGroups --------------
 -------------- getStratumGroups OK -----------
 -------------- getStratumGroups --------------
@@ -51,10 +51,10 @@
 Here the function returned 16 meta-models corresponding to different combinations of stratum groups (RE1, RE2, RE3, RS2) and climate scenarios (NoChange, Plus2Degrees, Plus4Degrees, Plus6Degrees).

 ## Getting the possible output types
-The simulation can return different output types such as species specific volumes or basal areas. To get the available output types for a particular meta-model, use the CBGetPossibleOutputTypes with the name of the stratum group as argument:
+The simulation can return different output types such as species specific volumes or basal areas. To get the available output types for a particular meta-model, use the MMGetPossibleOutputTypes with the name of the stratum group as argument:

 ~~~R
-> CBGetPossibleOutputTypes("RS2_Plus2Degrees")
+> MMGetPossibleOutputTypes("RS2_Plus2Degrees")
 -------------- getPossibleOutputTypes --------------
 -------------- getPossibleOutputTypes OK -----------
 -------------- getPossibleOutputTypes --------------
@@ -66,10 +66,10 @@
 In this example, the meta-model of stratum group "RS2_Plus2Degrees" has two output types: the volume of broadleaved species and the volume or coniferous species.

 ## Getting predictions from a meta-model
-The CBGetPrediction function makes it possible to obtain the prediction from a particular meta-model. For example, this call
+The MMGetPrediction function makes it possible to obtain the prediction from a particular meta-model. For example, this call

 ~~~R
-> CBGetPrediction("RS2_Plus2Degrees", 50, 0, "Coniferous")
+> MMGetPrediction("RS2_Plus2Degrees", 50, 0, "Coniferous")
 -------------- getPrediction --------------
 -------------- getPrediction OK -----------
 [1] 82.10176

CapsisBridgeRClient modified by Jean-Francois Lavoie

Jean-Francois Lavoie — Mon, 14 Feb 2022 21:19:21 -0000

--- v5
+++ v6
@@ -3,8 +3,6 @@

 ## Building the package
 This package relies on Rcpp and the CapsisBridgeClientLib C++ library to allow access to Capsis through gRPC calls. 
-Note : On windows, the RTools installation must have been performed prior to following these steps.  
-RTools can be found here : https://cran.r-project.org/bin/windows/Rtools/

 1. Follow these instructions first to build the C++ library under MinGW64 : https://sourceforge.net/p/capsisbridge/wiki/Building%20on%20Microsoft%20Windows%20and%20MinGW64/ 
 2. Start RStudio and open the CapsisBridge R client project
@@ -14,21 +12,20 @@
 6. Build the package using CTRL-SHIFT-B

 ## Getting connected to the server
-The connection to the server is made through the CBInitialize function:
+The connection to the server is made through the MMInitialize function:

 ~~~R
-> CBInitialize("localhost:50001")
+> MMInitialize("localhost:50002")
 [1] 0
 >
 ~~~

-The argument string must contain the IP address and the port number separated by a colon. The returned value 0 indicates a successful connection. 
+The argument string must contain the IP address and the port number separated by a colon. 

 ## Loading previously saved meta-models
-The meta-models are embedded in a meta-model manager which can be loaded and saved. When loading a meta-model manager, the file must be located in the root directory of the server. For example, the compressed file [metamodel.zip](https://sourceforge.net/projects/capsisbridge/files/metamodel.zip) contains two files: metaModel.zml and fittedMetaModel.zml. If both are extracted and placed at the root path of the server, they can be loaded using the CBLoad function:
-
+The meta-models are embedded in a meta-model manager which can be loaded and saved. When loading a meta-model, the file must be located in a known directory on the server. 
 ~~~R
-> CBLoad("fittedMetaModel.zml")
+> MMLoad("D:\\projects\\java\\CapsisBridge\\javaserver\\data\\QC_FMU02664_MS2_NoChange_AliveVolume_ConiferousSpecies.zml")
 -------------- load --------------
 -------------- load OK -----------
 [1] 0

CapsisBridgeRClient modified by Jean-Francois Lavoie

Jean-Francois Lavoie — Mon, 22 Nov 2021 21:11:16 -0000

--- v4
+++ v5
@@ -9,7 +9,9 @@
 1. Follow these instructions first to build the C++ library under MinGW64 : https://sourceforge.net/p/capsisbridge/wiki/Building%20on%20Microsoft%20Windows%20and%20MinGW64/ 
 2. Start RStudio and open the CapsisBridge R client project
 3. Modify the Makevars.win file into the src subfolder and set the variable CAPSISBRIDGE_INSTALLDIR to the location where the C++ library has been installed (typically the install folder under the build_mingw64 folder of the c++ lib folder).  i.e. : /w/NRCan/cpp/CapsisBridge/cppclient/build_mingw64/install
-4. Build the package using CTRL-SHIFT-B
+4. (Linux only) On Linux systems, when gRPC is installed locally, we must specify the location of the grpc installation so that the Makevars file pkg-config statement can find grpc at its dependencies, i.e. ~/.local/lib/pkgconfig using command : 
+  `export PKG_CONFIG_PATH=~/.local/lib/pkgconfig`
+6. Build the package using CTRL-SHIFT-B

 ## Getting connected to the server
 The connection to the server is made through the CBInitialize function:

CapsisBridgeRClient modified by Jean-Francois Lavoie

Jean-Francois Lavoie — Mon, 22 Nov 2021 18:18:18 -0000

--- v3
+++ v4
@@ -3,6 +3,9 @@

 ## Building the package
 This package relies on Rcpp and the CapsisBridgeClientLib C++ library to allow access to Capsis through gRPC calls. 
+Note : On windows, the RTools installation must have been performed prior to following these steps.  
+RTools can be found here : https://cran.r-project.org/bin/windows/Rtools/
+
 1. Follow these instructions first to build the C++ library under MinGW64 : https://sourceforge.net/p/capsisbridge/wiki/Building%20on%20Microsoft%20Windows%20and%20MinGW64/ 
 2. Start RStudio and open the CapsisBridge R client project
 3. Modify the Makevars.win file into the src subfolder and set the variable CAPSISBRIDGE_INSTALLDIR to the location where the C++ library has been installed (typically the install folder under the build_mingw64 folder of the c++ lib folder).  i.e. : /w/NRCan/cpp/CapsisBridge/cppclient/build_mingw64/install

CapsisBridgeRClient modified by Jean-Francois Lavoie

Jean-Francois Lavoie — Mon, 22 Nov 2021 18:10:50 -0000

--- v2
+++ v3
@@ -1,5 +1,12 @@
 # R Client for CAPSISBridge
 [TOC]
+
+## Building the package
+This package relies on Rcpp and the CapsisBridgeClientLib C++ library to allow access to Capsis through gRPC calls. 
+1. Follow these instructions first to build the C++ library under MinGW64 : https://sourceforge.net/p/capsisbridge/wiki/Building%20on%20Microsoft%20Windows%20and%20MinGW64/ 
+2. Start RStudio and open the CapsisBridge R client project
+3. Modify the Makevars.win file into the src subfolder and set the variable CAPSISBRIDGE_INSTALLDIR to the location where the C++ library has been installed (typically the install folder under the build_mingw64 folder of the c++ lib folder).  i.e. : /w/NRCan/cpp/CapsisBridge/cppclient/build_mingw64/install
+4. Build the package using CTRL-SHIFT-B

 ## Getting connected to the server
 The connection to the server is made through the CBInitialize function:

CapsisBridgeRClient modified by Mathieu Fortin

Mathieu Fortin — Wed, 17 Mar 2021 15:07:37 -0000

--- v1
+++ v2
@@ -1 +1,70 @@
 # R Client for CAPSISBridge
+[TOC]
+
+## Getting connected to the server
+The connection to the server is made through the CBInitialize function:
+
+~~~R
+> CBInitialize("localhost:50001")
+[1] 0
+>
+~~~
+
+The argument string must contain the IP address and the port number separated by a colon. The returned value 0 indicates a successful connection. 
+
+## Loading previously saved meta-models
+The meta-models are embedded in a meta-model manager which can be loaded and saved. When loading a meta-model manager, the file must be located in the root directory of the server. For example, the compressed file [metamodel.zip](https://sourceforge.net/projects/capsisbridge/files/metamodel.zip) contains two files: metaModel.zml and fittedMetaModel.zml. If both are extracted and placed at the root path of the server, they can be loaded using the CBLoad function:
+
+~~~R
+> CBLoad("fittedMetaModel.zml")
+-------------- load --------------
+-------------- load OK -----------
+[1] 0
+>
+~~~
+
+## Getting the available stratum groups
+Calling the CBGetStratumGroups method returns the available stratum groups in the meta-model manager instance. For example,
+
+~~~R
+> CBGetStratumGroups()
+-------------- getStratumGroups --------------
+-------------- getStratumGroups OK -----------
+-------------- getStratumGroups --------------
+-------------- getStratumGroups OK -----------
+ [1] "RE1_NoChange"     "RE1_Plus2Degrees" "RE1_Plus4Degrees" "RE1_Plus6Degrees" "RE2_NoChange"    
+ [6] "RE2_Plus2Degrees" "RE2_Plus4Degrees" "RE2_Plus6Degrees" "RE3_NoChange"     "RE3_Plus2Degrees"
+[11] "RE3_Plus4Degrees" "RE3_Plus6Degrees" "RS2_NoChange"     "RS2_Plus2Degrees" "RS2_Plus4Degrees"
+[16] "RS2_Plus6Degrees"
+>
+~~~
+
+Here the function returned 16 meta-models corresponding to different combinations of stratum groups (RE1, RE2, RE3, RS2) and climate scenarios (NoChange, Plus2Degrees, Plus4Degrees, Plus6Degrees).
+
+## Getting the possible output types
+The simulation can return different output types such as species specific volumes or basal areas. To get the available output types for a particular meta-model, use the CBGetPossibleOutputTypes with the name of the stratum group as argument:
+
+~~~R
+> CBGetPossibleOutputTypes("RS2_Plus2Degrees")
+-------------- getPossibleOutputTypes --------------
+-------------- getPossibleOutputTypes OK -----------
+-------------- getPossibleOutputTypes --------------
+-------------- getPossibleOutputTypes OK -----------
+[1] "Broadleaved" "Coniferous" 
+>
+~~~
+
+In this example, the meta-model of stratum group "RS2_Plus2Degrees" has two output types: the volume of broadleaved species and the volume or coniferous species.
+
+## Getting predictions from a meta-model
+The CBGetPrediction function makes it possible to obtain the prediction from a particular meta-model. For example, this call
+
+~~~R
+> CBGetPrediction("RS2_Plus2Degrees", 50, 0, "Coniferous")
+-------------- getPrediction --------------
+-------------- getPrediction OK -----------
+[1] 82.10176
+> 
+~~~
+
+returns the volume prediction at 50 years of age at the beginning of the simulation for coniferous species in the stratum group  "RS2_Plus2Degrees".

CapsisBridgeRClient modified by Mathieu Fortin

Mathieu Fortin — Tue, 17 Nov 2020 18:19:45 -0000