Matlab SDK Documentation
This Matlab class allows easy access to the functions provided in the BoonLogic Nano API.
NOTE: In order to use this package, it is necessary to acquire a BoonNano license from Boon Logic, Inc. A startup email will be sent providing the details for using this package.
- Website: https://github.com/boonlogic/expert-matlab-sdk
- API Documentation: docs.boonlogic.com
- Matlab Documentation:
doc BoonNanoSDk
in Matlab Command Window
Installation of BoonNano
-
Download the expert-matlab-sdk repository to your computer
-
Add the expert-matlab-sdk folder to your Matlab path
-
NOTE: Requires Matlab version 2018a or newer
License Configuration
Note: A license must be obtained from Boon Logic to use the BoonNano Matlab SDK
The license should be saved in ~/.BoonLogic.license
on unix machines or C:\Users\<user>\.BoonLogic.license
on windows machines. This file will contain the following format:
{
"default": {
"api-key": "API-KEY",
"server": "WEB ADDRESS",
"api-tenant": "API-TENANT"
}
}
The API-KEY, WEB ADDRESS, and API-TENANT will be unique to your obtained license.
The .BoonLogic.license file will be consulted by the BoonNano Matlab SDK to successfully find and authenticate with your designated server.
Connectivity Test
The following Matlab script provides a basic proof-of-connectivity:
Examples/connect_example.m
% create new nano handle
nano = BoonNanoSDK('default');
% open/attach to nano
[success, response] = nano.openNano('my-instance');
if success
fprintf('Created New Instance! \n');
else
fprintf('Failed To Create New Instance \n');
end
% fetch the version information for this nano instance
[success, response] = nano.getVersion();
if success
fprintf('Boon Nano API Version: %s \n', response.api_version);
else
fprintf('getVersion() Failed \n');
end
% close/detach the nano instance
[success, reponse] = nano.closeNano();
if success
fprintf('Closed Instance... \n');
else
fprintf('closeNano() Failed \n');
end
Running the BoonNano_ExampleUsage.m script should yield the following output:
Created New Instance!
Boon Nano API Version: expert/v3
Closed Instance...
Tutorials
- Introduction To Clustering: Introduction To Clustering
- The General Pipeline: The General Pipeline
Example Scripts
- Example Clustering: BoonNano_ExampleUsage.m
- Image Analysis: BoonNano_ImageExample.m
- Streaming Data: BoonNano_StreamingExample.m
- Connection Test: connect_example.m