Skip to content

Commit 654610c

Browse files
created readme file based on old tf2.3 version
1 parent 33ea3f7 commit 654610c

File tree

5 files changed

+57
-1
lines changed

5 files changed

+57
-1
lines changed

README.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,33 @@
1-
# TF2.4_IVIM_code_collection
1+
# TF2.4_IVIM_code_collection
2+
3+
The ISMRM Open Science Initiative for Perfusion Imaging (OSIPI) is an initiative of the ISMRM Perfusion Study Group, founded in 2019 after a membership survey, and with a mission to:
4+
5+
>“promote the sharing of perfusion imaging software in order to eliminate the practice of duplicate development, improve the reproducibility of perfusion imaging research, and speed up the translation into tools for discovery science, drug development, and clinical practice”
6+
7+
This **IVIM code collection** code library is maintained by OSIPI [Taskforce 2.4](https://www.osipi.org/task-force-2-4/) (*currently not available*) and aims to collect, test and share open-source code related to intravoxel incoherent motion (IVIM) analysis of diffusion encoded MRI data to be used in research and software development. Code contributions can include any code related IVIM analysis (denoising, motion correction, model fitting, etc.), but at an initial phase, development of tests and other features of the repository will predominantly focus on fitting algorithms. A future goal of the IVIM OSIPI task force is to develop a fully tested and harmonized code library, building upon the contributions obtained through this initiative.
8+
9+
## How to contibute
10+
11+
If you would like to get involve in OSIPI and work within the task force, please email the contacts listed on our website.
12+
13+
If you would like to contribute with code, please follow the instructions below:
14+
15+
* [Setting up Git](doc/setting_up_git.md)
16+
* [How to create a copy of the respository and contribute changes to the repository](doc/create_local_copy_of_repository.md)
17+
* [Guidelines for code contribution](doc/guidelines_for_contributions.md)
18+
* [Guidelines to creating a test file](doc/creating_test.md)
19+
20+
## Repository Organization
21+
22+
The repository is organized in four main folders along with configuration files for automated testing.
23+
24+
The **doc** folder contains all documentation related to the repository of task force 2.4.
25+
26+
The **src** folder contains source code contributed by the the community. Within **src**, the **original** folder contains the code to be tested, and the **wrappers** folder contains code for harmizing the calls the different code contributions. Within the **original** folders, contributions are stored in Initials_InstitutionCountry, e.g. src/original/OGC_AmsterdamUMC.
27+
28+
The **test** folder contains the test files corresponding to the contributed code in **src**. *to be structured*
29+
30+
The **utils** folder contains various helpful tools.
31+
32+
## View Testing Reports
33+
*to be added*
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# How to create a copy of the repository and contribute changes
2+
3+
The instructions outlined below shows a few (but far from all) ways for creating a copy of the repository and contribute with changes.
4+
5+
# Using Visual Studio Code
6+
*to be added*
7+
8+
# Alternative approach
9+
*to be added*

doc/creating_test.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Guidelines for creating test files
2+
3+
*to be added*

doc/guidelines_for_contributions.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Guidelines for code contribution
2+
3+
## Contributor Information
4+
*to be added*
5+
6+
## Source code format
7+
*to be added*
8+
9+
## How to submit
10+
*to be added*

doc/setting_up_git.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
## Installing Git
2+
To install a fresh copy of Git or to upgrade to the latest version, please follow the instructions outlined in: [Installing Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)

0 commit comments

Comments
 (0)