Skip to content

Commit f773c75

Browse files
committed
describe what dependencies are needed and how to install them.
1 parent 0f83ffa commit f773c75

File tree

4 files changed

+36
-0
lines changed

4 files changed

+36
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,19 @@
11
# motion_Visual-Localizer
22
This repo collects the most common localizers in use to define hMT/V5
3+
4+
5+
## Installing dependencies
6+
7+
All the dependencies needed to run this are listed in the [mpm-requirements.txt file](.mpm-requirements.txt). If those functions are not in the matlab path the scripts in this repository will not work.
8+
9+
If you are using the [matlab package manager](https://github.com/mobeets/mpm), you can simply download the appropriate version of those dependencies and add them to your path by running the `getDependencies` function.
10+
11+
```matlab
12+
getDependencies('update')
13+
```
14+
15+
If you only already have the appropriate version but just want to add them to the matlab path, then run.
16+
17+
```matlab
18+
getDependencies()
19+
```

Visual-loc_translational/NOTES.md

Whitespace-only changes.

getDependencies.m

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
function getDependencies(action)
2+
3+
if nargin<1
4+
action = '';
5+
end
6+
7+
switch action
8+
case 'update'
9+
% install dependencies
10+
mpm install -i mpm-requirements.txt -f -c visual_motion_localizer
11+
end
12+
13+
% adds them to the path
14+
mpm_folder = fileparts(which('mpm'));
15+
addpath(genpath(fullfile(mpm_folder, 'mpm-packages', 'mpm-collections', 'visual_motion_localizer')));
16+
17+
end

mpm-requirements.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
CPP_BIDS -u https://github.com/cpp-lln-lab/CPP_BIDS.git
2+
CPP_PTB -u https://github.com/cpp-lln-lab/CPP_PTB.git

0 commit comments

Comments
 (0)