Skip to content

Commit 262bdac

Browse files
committed
readme adapt for notebook and rename notebook
adapt readme to include notebook and rename notebook
1 parent 4e9687d commit 262bdac

3 files changed

+997
-3
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ If you would like to contribute with code, please follow the instructions below:
1717
* [Guidelines for IVIM code contribution](doc/guidelines_for_contributions.md)
1818
* [Guidelines to creating a test file](doc/creating_test.md)
1919

20+
If you would like to use code from the repository and/or are new to Github or IVIM, please see the jupyter notebook below:
21+
* [Introduction to TF2.4_IVIM-MRI_CodeCollection github and IVIM Analysis using Python](doc/Introduction_to_TF24_IVIM-MRI_CodeCollection_github_and_IVIM_Analysis_using_Python.ipynb)
22+
2023
## Repository Organization
2124

2225
The repository is organized in four main folders along with configuration files for automated testing.

doc/Introduction to TF2.4_IVIM-MRI_CodeCollection github and IVIM Analysis using Python.ipynb renamed to doc/.ipynb_checkpoints/Introduction_to_TF24_IVIM-MRI_CodeCollection_github_and_IVIM_Analysis_using_Python-checkpoint.ipynb

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,9 @@
3434
"id": "daac03e5",
3535
"metadata": {},
3636
"source": [
37-
"## Import necessary libraries"
37+
"## Install and import necessary libraries\n",
38+
"\n",
39+
"If you have not used python before, we need to ensure that you have the downloaded the required packages. Open the terminal. "
3840
]
3941
},
4042
{
@@ -43,6 +45,30 @@
4345
"id": "56273b2a",
4446
"metadata": {},
4547
"outputs": [],
48+
"source": [
49+
"# install packages through the terminal\n",
50+
"pip3 install numpy\n",
51+
"pip3 install matplotlib\n",
52+
"pip3 install scipy\n",
53+
"pip3 install nibabel"
54+
]
55+
},
56+
{
57+
"cell_type": "code",
58+
"execution_count": null,
59+
"id": "6a1e6372-ce1e-47b9-881e-e76bf104d9fa",
60+
"metadata": {},
61+
"outputs": [],
62+
"source": [
63+
"# Once all the packages are installed, you need to import them."
64+
]
65+
},
66+
{
67+
"cell_type": "code",
68+
"execution_count": 1,
69+
"id": "9654f12d-6cfc-4639-884e-d7f2b23fa59f",
70+
"metadata": {},
71+
"outputs": [],
4672
"source": [
4773
"import numpy as np\n",
4874
"import matplotlib.pyplot as plt\n",
@@ -61,7 +87,8 @@
6187
"source": [
6288
"# Loading Data\n",
6389
"\n",
64-
"Due to the large data size, we stored example data elsewhere: https://zenodo.org/records/10696605\n"
90+
"Due to the large data size, we stored example data elsewhere: https://zenodo.org/records/10696605\n",
91+
"Make sure you have enough space on your computer to store the data."
6592
]
6693
},
6794
{
@@ -929,7 +956,7 @@
929956
"name": "python",
930957
"nbconvert_exporter": "python",
931958
"pygments_lexer": "ipython3",
932-
"version": "3.10.9"
959+
"version": "3.11.7"
933960
}
934961
},
935962
"nbformat": 4,

doc/Introduction_to_TF24_IVIM-MRI_CodeCollection_github_and_IVIM_Analysis_using_Python.ipynb

Lines changed: 964 additions & 0 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)