isetbioLocalHook.m

function isetbioLocalHookTemplate 
% Method to set ISETBIO-specific preferences. 
%
% Syntax:
%   isetbioLocalHookTemplate
%
% Description:
%    Generally, this function should be edited for your website and then
%    run once.
%
%    You should be able just to use this template version without editing
%    for both full and fast validations -- it pulls its data off a server
%    we have set up via the RemoteDataToolbox facility.
%
%    Note that you still want to have the remoteDataToolboxConfig set up
%    even if you aren't using the RemoteDataToolbox for validations.
%
%    If you are using the ToolboxToolbox, the copy this file to your local
%    hooks folder and delete "Template" from the filename.  The TbTb will
%    then run it when you deploy isetbio.
%
% Inputs:
%    None.
%
% Outputs:
%    None.
%
% Optional key/value pairs:
%    None.
%

% Specify project-specific preferences for unit test toolbox
% 'projectName'             - String. The project's name (also the
%                             preferences group name). Default 'isetbio'
% 'validationRootDir'       - String. The directory location where the
%                             'scripts' subdirectory resides. Default
%                             fullfile(isetbioRootPath, 'validation')
% 'alternateFastDataDir'    - String. An alternate FAST (hash) data
%                             directory location. Specify '' to use the
%                             default location, i.e.,
%                             $validationRootDir/data/fast. Default ''.
% 'alternateFullDataDir'    - String. An alternate FULL data directory
%                             location. Specify '' to use the default
%                             location, i.e., $validationRootDir/data/full.
%                             Default ''.
% 'useRemoteDataToolbox'    - Boolean. If true use the Remote Data Toolbox
%                             to fetch full validation data on demand.
%                             Default false.
% 'remoteDataToolboxConfig' - String. The struct, file path, or project
%                             name with Remote Data Toolbox configuration.
%                             Default 'isetbio'.
% 'githubRepoURL'           - String. The Github URL for the project. This
%                             is only used for publishing tutorials.
%                             Default 'http://isetbio.github.io/isetbio'.
% 'generateGroundTruthDataIfNotFound'
%                           - Boolean. Flag indicating whether or not to
%                             generate the ground truth if one is not
%                             found. Default false.
% 'listingScript'           - String. The listing script name. Default
%                             'ieValidateListAllValidationDirs'.
% 'coreListingScript'       - String. The core listing script name. Default
%                             'ieValidateListCoreValidationFiles'.
% 'numericTolerance'        - Numeric. Numeric tolerance for comparisons
%                             with validation data. Default 1e-11.


% Get Dropbox Validation RootDir location
computerInfo = GetComputerInfo();
switch (computerInfo.localHostName)
    case 'Ithaka'
        % Nicolas' M1 Macbook Pro
        dropboxValidationRootDirPath = '/Volumes/SSDdisk/Aguirre-Brainard Lab Dropbox/Nicolas Cottaris';
    case 'Crete'
        % Nicolas' M1 MacStudio Ultra
        dropboxValidationRootDirPath = '/Volumes/SSDdisk/Aguirre-Brainard Lab Dropbox/Nicolas Cottaris';
    otherwise
        error('Dropbox validation root directory location not available for computer named: ''%s''.', computerInfo.localHostName);          
end

p = struct(...
    'projectName', 'isetbio', ...
    'validationRootDir', fullfile(isetbioRootPath, 'validation'), ...
    'alternateFastDataDir', '', ...
    'alternateFullDataDir', fullfile(dropboxValidationRootDirPath, 'ISETBioValidationFiles/gradleFiles/validationFull'), ...
    'useRemoteDataToolbox', ~true, ...
    'remoteDataToolboxConfig', 'isetbio', ...
    'githubRepoURL', 'http://isetbio.github.io/isetbio', ...
    'generateGroundTruthDataIfNotFound', ~true, ...
    'listingScript', 'ieValidateListAllValidationDirs', ...
    'coreListingScript', 'ieValidateListCoreValidationFiles', ...
    'numericTolerance', 1e-11);

% Add to the path the Dropbox Validation RootDir location
addpath(genpath(p.alternateFullDataDir));

generatePreferenceGroup(p);
UnitTest.usePreferencesForProject(p.projectName);

end

function generatePreferenceGroup(p)
% Remove any existing preferences for this project
%
% Syntax:
%   generatePreferenceGroup(p)
%
% Description:
%    Remove existing preferences for the provided project p.
%
% Inputs:
%    p - Object. A project object.
%
% Outputs:
%    None.
%
% Optional key/value pairs:
%    None.
%

if ispref(p.projectName), rmpref(p.projectName); end

% generate and save the project-specific preferences
setpref(p.projectName, 'projectSpecificPreferences', p);
fprintf('Generated and saved preferences specific to the %s project.\n', p.projectName);
end