Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation updates #141

Merged
merged 55 commits into from
Jan 24, 2024
Merged
Changes from 1 commit
Commits
Show all changes
55 commits
Select commit Hold shift + click to select a range
6986e90
[BUG] inside unit_tests workflow
bclenet Aug 31, 2023
d6e67f3
Merge branch 'Inria-Empenn:main' into main
bclenet Aug 31, 2023
c3bfc53
Merge branch 'Inria-Empenn:main' into main
bclenet Sep 4, 2023
4b30504
Merge branch 'Inria-Empenn:main' into main
bclenet Sep 19, 2023
fd15ffc
Merge branch 'Inria-Empenn:main' into main
bclenet Sep 21, 2023
6715950
[DOC] fix some broken links
bclenet Sep 22, 2023
57b8c86
[DOC] adding template for pipeline testing
bclenet Sep 22, 2023
2c891c2
[DOC] adding template for pipeline testing
bclenet Sep 22, 2023
552e18c
About implemented_pipelines
bclenet Sep 25, 2023
b6f21f4
Deal with test template
bclenet Sep 25, 2023
6ebe5d2
Merge branch 'Inria-Empenn:main' into main
bclenet Sep 29, 2023
0a584dd
Merge branch 'Inria-Empenn:main' into main
bclenet Sep 29, 2023
e284b80
Merge branch 'Inria-Empenn:main' into main
bclenet Sep 29, 2023
5774813
Merge branch 'Inria-Empenn:main' into main
bclenet Oct 5, 2023
8f12d3d
Merge branch 'Inria-Empenn:main' into main
bclenet Oct 5, 2023
7c3b6df
Merge branch 'main' into documentation
bclenet Oct 5, 2023
91dc744
Merge branch 'Inria-Empenn:main' into main
bclenet Oct 10, 2023
c10e3a4
Merge branch 'main' into documentation
bclenet Oct 13, 2023
0436fe4
[DOC] new readme for the doc
bclenet Oct 13, 2023
bfcf3dd
Changes in README.md
bclenet Oct 13, 2023
d212e1d
[DOC] slight changes to docs/README.md
bclenet Oct 13, 2023
c03e9d1
Merge branch 'Inria-Empenn:main' into main
bclenet Nov 20, 2023
fe0d25b
Merge branch 'Inria-Empenn:main' into main
bclenet Nov 22, 2023
04d5ff2
Merge branch 'Inria-Empenn:main' into main
bclenet Nov 22, 2023
6466b29
Merge branch 'main' into documentation
bclenet Nov 30, 2023
29870d5
Add links to past events
bclenet Nov 30, 2023
e4f369d
Changes in readme.md
bclenet Nov 30, 2023
142f89c
fMRI trail
bclenet Nov 30, 2023
7b7fb89
Adding trail description in contribution guide
bclenet Dec 6, 2023
23b93f6
Separate trails in contribution guide
bclenet Dec 6, 2023
6f3dd73
[TEST] Solving pytest issues with template test
bclenet Dec 6, 2023
c9ee889
Merge branch 'Inria-Empenn:main' into main
bclenet Jan 5, 2024
933e87f
Merge branch 'main' into documentation
bclenet Jan 9, 2024
5803501
Changing docker image in use
bclenet Jan 9, 2024
e297685
FSL template correction
bclenet Jan 10, 2024
9213dc4
[DOC] writing test files
bclenet Jan 10, 2024
9bfc89c
Merge branch 'Inria-Empenn:main' into main
bclenet Jan 10, 2024
d2b8452
Merge branch 'main' into documentation
bclenet Jan 10, 2024
7d5fa82
Codespell
bclenet Jan 10, 2024
11736e6
First step in writing documentation about NARPS
bclenet Jan 10, 2024
c5fd548
[DOC] completing doc about narps
bclenet Jan 11, 2024
6c9d7a3
[DOC] completing doc about narps
bclenet Jan 11, 2024
a016bdd
[DOC] completing doc about narps
bclenet Jan 11, 2024
7493f74
Merge branch 'Inria-Empenn:main' into main
bclenet Jan 11, 2024
a73f3c3
[DATALAD] change results url
bclenet Jan 11, 2024
f03f50e
Merge pull request #3 from bclenet/results
bclenet Jan 11, 2024
68ea23c
[DOC] reference to the github project for reproduction mgmt
bclenet Jan 11, 2024
f4c0c24
[DOC] adding team id choices for narps open runner
bclenet Jan 12, 2024
9120dda
Merge branch 'main' into documentation
bclenet Jan 12, 2024
6ebd536
[DOC] list of available team ids in command tools documentation
bclenet Jan 15, 2024
ecce46a
[DOC] configuration info inside INSTALL.md
bclenet Jan 16, 2024
5b46057
[DOC] configuration info inside INSTALL.md
bclenet Jan 16, 2024
a737df5
Merge branch 'Inria-Empenn:main' into main
bclenet Jan 19, 2024
b8c1fda
NARPS Exclusion comments
bclenet Jan 24, 2024
f518012
Merge branch 'main' into documentation
bclenet Jan 24, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
[TEST] Solving pytest issues with template test
bclenet committed Dec 6, 2023
commit 6f3dd73f227c8f72db54e31873b3336d6ebe69ef
21 changes: 10 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -17,7 +17,7 @@ Not sure which pipeline to start with :thinking:? The [pipeline dashboard](https
## 2 - Interact using issues
`🧠 fMRI soft` `🐍 Python`

Browse [issues](https://github.com/Inria-Empenn/narps_open_pipelines/issues/) before starting a new one. If the pipeline is :orange_circle: the associated issues are listed on the [pipeline dashboard](https://github.com/Inria-Empenn/narps_open_pipelines/wiki/pipeline_status).
Browse [issues](https://github.com/Inria-Empenn/narps_open_pipelines/issues/) before starting a new one. If the pipeline is :orange_circle:, the associated issues are listed on the [pipeline dashboard](https://github.com/Inria-Empenn/narps_open_pipelines/wiki/pipeline_status).

You can either:
* comment on an existing issue with details or your findings about the pipeline;
@@ -27,23 +27,23 @@ You can either:
> As soon as the issue is marked as `🏁 status: ready for dev` you can proceed to the next step.

## 3 - Use pull requests
`🧠 fMRI soft` `🐍 Python`
`🐍 Python`

1. If needed, [fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the repository;
1. [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the repository;
2. create a separate branch for the issue you're working on (do not make changes to the default branch of your fork).
3. push your work to the branch as soon as possible;
4. visit [this page](https://github.com/Inria-Empenn/narps_open_pipelines/pulls) to start a draft pull request.

> [!WARNING]
> Make sure you create a **Draft Pull Request** as described [here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork), and please stick to the description of the pull request template as much as possible.

## 4 - Reproduction

Continue writing your work and push it to the branch. Make sure you perform all the items of the pull request checklist.
## 4 - Reproduce pipeline

### Translate the pipeline description into code
`🐍 Python`

Write your code and push it to the branch. Make sure you perform all the items of the pull request checklist.

From the description provided by the team you chose, write Nipype workflows that match the steps performed by the teams (preprocessing, run level analysis, subject level analysis, group level analysis).

We created templates with modifications to make and holes to fill to help you with that. Find them in [`narps_open/pipelines/templates`](/narps_open/pipelines/templates).
@@ -54,18 +54,17 @@ We created templates with modifications to make and holes to fill to help you wi
> | --- | --- | --- | --- |
> | Q6O0 | SPM | Yes | [/narps_open/pipelines/team_Q6O0.py](/narps_open/pipelines/team_Q6O0.py) |

Once your work is ready, you may ask a reviewer to your pull request, as described [here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review). Please turn your draft pull request into a *regular* pull request, by clicking **Ready for review** in the pull request page.

### Run the pipeline and produce evidences
`🧠 fMRI soft`

From the description provided by the team you chose, perform the analysis on the associated software to get as many metadata (log, configuration files, and other relevant files for reproducibility) as possible from the execution. Complementary hints and commend on the process would definitely be welcome, to enrich the description (e.g.: relevant parameters not written in the description, etc.).
From the description provided by the team you chose, perform the analysis on the associated software to get as many metadata (log, configuration files, and other relevant files for reproducibility) as possible from the execution. Complementary hints and comments on the process would definitely be welcome, to enrich the description (e.g.: relevant parameters not written in the description, etc.).

Especially these files contain valuable information about model design:
* for FSL pipelines, `design.fsf` setup files coming from FEAT ;
* for SPM pipelines, `matlabbatch` files.

### Request Review
`🧠 fMRI soft` `🐍 Python`

Once your work is ready, you may add a reviewer to your PR, as described [here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review). Please turn your draft pull request into a *regular* pull request, by clicking **Ready for review** in the pull request page.
You can attach these files as comments on the pipeline reproduction issue.

**:wave: Thank you for contributing to the project!**
2 changes: 1 addition & 1 deletion pytest.ini
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[pytest]
addopts = --strict-markers
addopts = --strict-markers --ignore=tests/pipelines/templates/
testpaths =
tests
markers =
5 changes: 0 additions & 5 deletions tests/conftest.py
Original file line number Diff line number Diff line change
@@ -18,11 +18,6 @@
from narps_open.utils.configuration import Configuration
from narps_open.data.results import ResultsCollection

# A list of test files to be ignored
collect_ignore = [
'tests/pipelines/templates/test_team_XXXX.py' # test template
]

# Init configuration, to ensure it is in testing mode
Configuration(config_type='testing')