Merge pull request #13 from Remi-Gau/remi-add_dependency_check

add PTB version check

Author: Remi-Gau

README.md

@@ -3,9 +3,25 @@
 [![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
-List of PsychToolBox (PTB) related functions for the Crossmodal Perpcetion and Plasticity lab (CPP)
+This is List of Crossmodal Perpeption and Plasticity lab (CPP) PsychToolBox (PTB) toolbox.
 
-Most of the functions here are mostly wrappers around some PTB functions to facilitate their use and to have a codebase to facilitate their reuse.
+Those functions are mostly wrappers around some PTB functions to facilitate their use and to have a codebase to facilitate their reuse.
+
+
+## Requirements
+
+Make sure that the following toolboxes are installed and added to the matlab / octave path.
+
+For instructions see the following links:
+
+| Requirements                                             | Used version |
+|----------------------------------------------------------|--------------|
+| [PsychToolBox](http://psychtoolbox.org/)  Duuuuhh        | >3.0.13      |
+| [Matlab](https://www.mathworks.com/products/matlab.html) | 201??        |
+| or [octave](https://www.gnu.org/software/octave/)        | 4.?          |
+
+The exact version required for this to work but it is known to work with:
+-   matlab 2017a or octave 4.2.2 and PTB 3.0.16.
 
 ## Code guidestyle
 

checkDependencies.m

@@ -0,0 +1,28 @@
+function checkDependencies()
+% Checks that the right dependencies are installed.
+
+printCredits()
+
+
+PTB = '3.0.16';
+
+fprintf('Checking dependencies\n')
+
+% check ptb version
+try
+a = PsychtoolboxVersion
+fprintf(' Using %s %s\n', a, b)
+if any(~strcmp(a, PTB))
+    str = sprintf('%s %s %s.\n%s', ...
+        'The current version PTB version is not', PTB,...
+        'In case of problems (e.g json file related) consider updating.');
+    warning(str); %#ok<*SPWRN>
+end
+catch
+    error('Failed to check the PTB version: Are you sure that PTB is in the matlab path?')
+end
+
+
+fprintf(' We got all we need. Let''s get to work.\n')
+
+end

initPTB.m

@@ -4,6 +4,7 @@
 % We might want to add a couple of IF in case the experiment does not use
 % audio for example.
 
+checkDependencies()
 
 
 % For octave: to avoid displaying messenging one screen at a time

printCredits.m

@@ -0,0 +1,42 @@
+function printCredits()
+
+version = '0.0.1';
+
+contributors = {...
+    'Rémi Gau', ...
+    'Marco Barilari'};
+
+% DOI_URL = 'https://doi.org/10.5281/zenodo.3554331.';
+
+repoURL = 'https://github.com/cpp-lln-lab/CPP_PTB';
+
+disp( '____________________________________________________________________________________________');
+disp( '____________________________________________________________________________________________');
+disp( '                                        ');
+disp( '  __  ____  ____      ____   _____   _  ');
+disp( ' / _)(  _ \(  _ \    (  _ \ |_   _| | ) ');
+disp( '( (_  )___/ )___/     )___/   | |   | \ ');
+disp( ' \__)(__)  (__)      (__)     |_|   |__)');
+disp( '                                        ');
+
+splash = 'Thank you for using the CPP PTB - version %s. ';
+fprintf(splash, version)
+fprintf('\n\n');
+
+fprintf('Current list of contributors includes\n')
+for iCont = 1:numel(contributors)
+ fprintf(' %s\n', contributors{iCont})
+end
+fprintf('\b\n\n')
+
+% fprintf('Please cite using the following DOI: \n %s\n\n', DOI_URL)
+
+fprintf('For bug report, suggestions for improvements or contributions see our github repo: \n %s\n\n', repoURL)
+
+
+disp( '____________________________________________________________________________________________');
+disp( '____________________________________________________________________________________________');
+
+fprintf('\n\n')
+
+end