-
Notifications
You must be signed in to change notification settings - Fork 5
Installation
You can install this scitranClient and another essential toolbox, Guillaume Flandin's code to read and write JSON files (JSONio) by
git clone https://github.com/vistasoft/scitran
git clone https://github.com/gllmflndn/JSONio
This will create two directories, scitran and JSONio. Please add both directories to your path, say by using
chdir(<scitran directory>); addpath(genpath(pwd));
chdir(<JSONio directory>); addpath(genpath(pwd));
The SDK is installed as a Matlab toolbox managed using their 'Add-Ons' methods. You can do the installation with the scitran function
stFlywheelSDK('install');
That command downloads the toolbox from the web and installs it as an Add-On toolbox. You can verify or uninstall the toolbox using
status = stFlywheelSDK('verify')
status = stFlywheelSDK('uninstall')
The SDK is under active development, and we anticipate several new releases through 2018 and into 2019. To install a new specific release number, we suggest you uninstall, restart matlab, and then install. We have done this sequence several times with success; we haven't succeeded without the restart. For example, to upgrade to version '2.4.3' you can do this:
stFlywheelSDK('uninstall');
RESTART MATLAB
stFlywheelSDK('install','sdkVersion','2.4.3');
The scitran methods are a kinder, gentler interface to the Flywheel SDK methods. They are organized to help neuroimaging scientists achieve basic goals.
If you prefer to use the SDK methods directly, or you want to write your own scitran methods based on the SDK methods, the scitran object makes them available through the fw slot. You can see the full list of methods by typing
st = scitran('stanfordlabs');
st.fw.<TAB>
The list of SDK commands will show up as optional Matlab completions.
- This api web page tersely describes the SDK methods. It also includes some chatty description and examples.
- This wiki web page has the core documentation.
The SDK is auto-generated into several different languages (Matlab, Python, and R).
We will write a stFlywheelCLI to install and invoke. Hasn't happened yet.