Merge pull request #163 from cpp-lln-lab/dev

[ENH] release 1.2.1

Author: Remi-Gau

.github/workflows/check_markdown.yml

@@ -7,11 +7,11 @@ on:
     branches:
       - master
   pull_request:
-    branches: '*'
+    branches: ['*']
 
 jobs:
   markdown-link-check:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@master
-    - uses: gaurav-nelson/github-action-markdown-link-check@v1
+    - uses: gaurav-nelson/github-action-markdown-link-check@v1

.github/workflows/check_md_links.yml

@@ -5,7 +5,7 @@ on:
     branches:
       - master
   pull_request:
-    branches: '*'
+    branches: ['*']
 
 jobs:
   build:

.github/workflows/miss_hit.yml

@@ -1,11 +1,11 @@
-name: MOxUnit
+name: tests and coverage
 
 on:
   push:
     branches:
       - master
   pull_request:
-    branches: '*'
+    branches: ['*']
 
 jobs:
   build:
@@ -16,7 +16,7 @@ jobs:
         submodules: true
         fetch-depth: 1
     - name: MOxUnit Action
-      uses: joergbrech/moxunit-action@v1.1
+      uses: joergbrech/moxunit-action@v1.2.0
       with:
         tests: tests
         src: src

.github/workflows/moxunit.yml renamed to .github/workflows/run_tests.yml

@@ -0,0 +1,44 @@
+repos:
+
+-   repo: local
+
+    hooks:
+
+    - id: mh_version
+      name: mh_version
+      entry: mh_style
+      args: [-v]
+      verbose: true
+      language: python
+      additional_dependencies: [miss_hit_core]
+
+    # - id: mh_style
+    #   name: mh_style
+    #   entry: mh_style
+    #   args: [--process-slx, --fix]
+    #   files: ^(.*\.(m|slx))$
+    #   language: python
+    #   additional_dependencies: [miss_hit_core]
+
+    # - id: mh_metric
+    #   name: mh_metric
+    #   entry: mh_metric
+    #   args: [--ci]
+    #   files: ^(.*\.(m|slx))$
+    #   language: python
+    #   additional_dependencies: [miss_hit_core]
+
+    # - id: mh_lint
+    #   name: mh_lint
+    #   entry: mh_lint
+    #   files: ^(.*\.(m|slx))$
+    #   language: python
+    #   additional_dependencies: [miss_hit]
+
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v2.0.0
+  hooks:
+    - id: trailing-whitespace
+    - id: end-of-file-fixer
+    - id: check-yaml
+    - id: check-added-large-files

.pre-commit-config.yaml

@@ -21,6 +21,6 @@ formats:
 
 # Optionally set the version of Python and requirements required to build your docs
 python:
-  version: 3.7
+  version: "3.7"
   install:
-    - requirements: requirements.txt
+    - requirements: requirements.txt

.readthedocs.yml

@@ -16,6 +16,14 @@
       "affiliation": "Université Catholique de Louvain",
       "name": "Battal, Ceren",
       "orcid": "0000-0002-9844-7630"
+    },
+    {
+      "affiliation": "Université Catholique de Louvain",
+      "name": "Falagiarda, Federica"
+    },
+    {
+      "affiliation": "Université Catholique de Louvain",
+      "name": "Shahzad, Iqra"
     }
   ],
   "keywords": [
@@ -26,4 +34,4 @@
   ],
   "license": "MIT license",
   "upload_type": "software"
-}
+}

.remarkrc

@@ -1,6 +1,7 @@
 # style guide (https://florianschanda.github.io/miss_hit/style_checker.html)
 line_length: 100
 regex_function_name: "CPP_[a-z]+(([A-Z]){1}[A-Za-z]+)*"
+regex_script_name: "CPP_[a-z]+(([A-Z]){1}[A-Za-z]+)*"
 copyright_entity: "Sam Schwarzkopf"
 copyright_entity: "Agah Karakuzu"
 copyright_entity: "CPP_PTB developers"
@@ -9,4 +10,4 @@ copyright_entity: "CPP_PTB developers"
 metric "cnest": limit 4
 metric "file_length": limit 500
 metric "cyc": limit 15
-metric "parameters": limit 5
+metric "parameters": limit 5

.zenodo.json

@@ -0,0 +1,85 @@
+% (C) Copyright 2021 CPP_PTB developers
+
+%% Demo showing how to use the createFramesTextureStructure and playVideoFrames functions
+
+% as it is, it presents two example videos in succession
+
+% add parent directory to matlab path (so we can access the CPP_PTB functions)
+addpath(fullfile(pwd, '..'));
+
+%% start with a clean slate
+clear;
+clc;
+
+%% initialize PTB % This can def be improved by using other CPP_PTB functions%
+
+% Skip the PTB sync test
+Screen('Preference', 'SkipSyncTests', 2);
+
+% Get the screen numbers and draw to the external screen if avaliable
+cfg.screen.idx = max(Screen('Screens'));
+
+% Set the PTB window background manually
+cfg.color.background = [127 127 127];
+
+% Get the screen numbers and draw to the external screen if avaliable
+cfg.screen.idx = max(Screen('Screens'));
+
+% Open an on screen window
+[cfg.screen.win, cfg.screen.winRect] = Screen('OpenWindow', cfg.screen.idx, cfg.color.background);
+
+%% Strcuture for video related info
+
+% The name of your "video" and its images format
+video.names = {'coffee', 'leaves'};
+
+% The number of frames of your video you want to present
+% If left empty, all available frames are taken
+video.frame.numbers = [];
+% video.frame.numbers = 30;
+% video.frame.numbers = [30,15];
+
+% The format fo the images
+video.frame.format = '.jpeg'; % can be any img format compatible with the "imread" function
+
+% the folder where the images are (from the current folder)
+video.stimuli.folder = 'stimuli/';
+
+% The frame rate at which you want to present your video
+video.frame.rate = 29.97;
+
+% Time bw videos in s
+video.isi = 1;
+
+%% present the videos in a loop
+
+for trial = 1:length(video.names)
+
+    % select name and folder where current video is
+    video.name = video.names{trial};
+    video.path = fullfile(video.stimuli.folder, video.name);
+
+    % how many frames are going to be presented
+    if numel(video.frame.numbers) < 1
+        video.frame.number = size(dir([video.path, '/*', video.frame.format]), 1);
+
+    elseif numel(video.frame.numbers) > 1
+        video.frame.number = video.frame.numbers(trial);
+
+    else
+        video.frame.number = video.frame.numbers;
+    end
+
+    % Read the images and create the stucture with their textures
+    [video, cfg] = createFramesTextureStructure(video, cfg);
+
+    % Play the video
+    playVideoFrames(video, cfg);
+
+    % ISI (better would be to use Flip)
+    WaitSecs(video.isi);
+
+end
+
+% The end
+sca;

README.md

@@ -5,8 +5,8 @@
 # from the environment for the first two.
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = .
-BUILDDIR      = _build
+SOURCEDIR     = source
+BUILDDIR      = build
 
 # Put it first so that "make" without argument is like "make help".
 help:
@@ -18,3 +18,6 @@ help:
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+doc:
+	@$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)"

demos/miss_hit.cfg

@@ -21,7 +21,7 @@
 author = 'CPP_PTB developers'
 
 # The full version, including alpha/beta/rc tags
-release = 'v1.0.0'
+release = 'v1.2.1'
 
 
 # -- General configuration ---------------------------------------------------

demos/video/CPP_playVideoFramesDemo.m

@@ -1,10 +1,4 @@
 # style guide (https://florianschanda.github.io/miss_hit/style_checker.html)
-line_length: 100
 regex_function_name: "((test_[a-z]+)|[a-z]+)(([A-Z]){1}[A-Za-z]+)*"
-suppress_rule: "copyright_notice"
-
-# metrics limit for the code quality (https://florianschanda.github.io/miss_hit/metrics.html)
-metric "cnest": limit 4
-metric "file_length": limit 500
-metric "cyc": limit 15
-metric "parameters": limit 5
+regex_script_name: "((test_[a-z]+)|[a-z]+)(([A-Z]){1}[A-Za-z]+)*"
+regex_parameter_name: "test_suite|[A-Z]{2,}|[a-z]+([A-Z]+[a-z]*)*"

demos/video/stimuli/coffee/coffee01.jpeg

@@ -1,4 +1,6 @@
 function test_suite = test_dotMotionSimulation %#ok<*STOUT>
+    %
+    % (C) Copyright 2020 CPP_PTB developers
     try % assignment of 'localfunctions' is necessary in Matlab >= 2016
         test_functions = localfunctions(); %#ok<*NASGU>
     catch % no problem; early Matlab versions can use initTestSuite fine

demos/video/stimuli/coffee/coffee02.jpeg

@@ -1,3 +1,6 @@
+%
+% (C) Copyright 2020 CPP_PTB developers
+
 addpath(fullfile(pwd, '..'));
 
 clear;

demos/video/stimuli/coffee/coffee03.jpeg

@@ -1,3 +1,6 @@
+%
+% (C) Copyright 2020 CPP_PTB developers
+
 % ensure that dot density contrast is not too low when we kill dots often enough
 
 % There is an actual official unit test in the tests folder so this here is more

demos/video/stimuli/coffee/coffee04.jpeg

@@ -1,6 +1,8 @@
 # style guide (https://florianschanda.github.io/miss_hit/style_checker.html)
 line_length: 100
 regex_function_name: "[a-z]+(([A-Z]){1}[A-Za-z]+)*"
+regex_script_name: "[a-z]+(([A-Z]){1}[A-Za-z]+)*"
+regex_parameter_name: "[A-Z]{2,}|[a-z]+([A-Z]+[a-z]*)*"
 copyright_entity: "Sam Schwarzkopf"
 copyright_entity: "Agah Karakuzu"
 copyright_entity: "CPP_PTB developers"
@@ -9,4 +11,4 @@ copyright_entity: "CPP_PTB developers"
 metric "cnest": limit 4
 metric "file_length": limit 500
 metric "cyc": limit 15
-metric "parameters": limit 5
+metric "parameters": limit 5

demos/video/stimuli/coffee/coffee05.jpeg

@@ -2,4 +2,5 @@ Sphinx
 sphinxcontrib-matlabdomain
 sphinxcontrib-napoleon
 sphinx_rtd_theme
-miss_hit==0.9.15
+miss_hit==0.9.29
+pre-commit