Skip to content

Commit b7482dc

Browse files
author
Tania Allard
committed
Minor updates on the content
1 parent f127184 commit b7482dc

4 files changed

Lines changed: 17 additions & 16 deletions

File tree

01_ProjecStructure.ipynb

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,26 +5,18 @@
55
"metadata": {},
66
"source": [
77
"# Project structure\n",
8+
"<h1>Project structure</h1>\n",
9+
"Good project layout ensures: \n",
810
"<ul>\n",
9-
"<li>There <strong>is no single</strong> way to organise a filesystem</li>\n",
10-
"<li>🔑 The key is to make sure that the structure is consistsent and\n",
11-
"informative</li>\n",
12-
"<li>Use a <strong>single root directory</strong> per project </li>\n",
13-
"<li>Find a structure that works for you and stick to it</li>\n",
14-
"</ul>\n",
15-
"<div class='info'> Start from the top level and add\n",
16-
"folders as your project evolves </div>\n",
17-
"</div>\n",
18-
" \n",
11+
" <li>Integrity of the data</li>\t<li>Portability of the project</li>\t<li>Easier to pick the project back up after a brak</li></ul> <br><br>There is no single way to organise a project.... butwe need to take advantage of the power of convention.<div class=\"info\">\t\"A place for everything, everything in its place\"<p class='caption_p'>- Benjamin Frankin</p></div></div> \n",
1912
" \n",
2013
"The image below gives a suggested structure for a project\n",
2114
"\n",
2215
"![](./assets/filesystem.PNG)\n",
2316
"\n",
2417
"\n",
2518
"We are going to create the project structure in your computer. \n",
26-
"You can do this manually, from the shell or use whatever\n",
27-
"method you prefer.\n",
19+
"You can do this manually, from the shell or use whatever method you prefer. But we want an opinionated approach for this.\n",
2820
"\n",
2921
"<a href=\"https://github.com/mkrapp/cookiecutter-reproducible-science\">\n",
3022
"Cookie cutter</a> to create our base filesystem and some support\n",

02_WorkingWithData.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@
233233
"name": "python",
234234
"nbconvert_exporter": "python",
235235
"pygments_lexer": "ipython3",
236-
"version": "3.6.4"
236+
"version": "3.6.5"
237237
}
238238
},
239239
"nbformat": 4,

03_ProcessData.ipynb

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -206,8 +206,10 @@
206206
"country_sub = importlib.import_module('.data.03_country-subset', 'scripts')\n",
207207
"```\n",
208208
"\n",
209-
"Also we need to make sure the imports are declared in `src/__init__.py`\n",
210-
"```python\n",
209+
"<div class='info'> Note that we need to make sure that the other subpackages are imported into the main package </div>\n",
210+
"\n",
211+
"So in the `src/__init__.py` you need to add:\n",
212+
"``` python\n",
211213
"from . import data\n",
212214
"from . import visualization\n",
213215
"```"
@@ -358,6 +360,13 @@
358360
" return HTML(styles)\n",
359361
"css_styling()"
360362
]
363+
},
364+
{
365+
"cell_type": "code",
366+
"execution_count": null,
367+
"metadata": {},
368+
"outputs": [],
369+
"source": []
361370
}
362371
],
363372
"metadata": {
@@ -376,7 +385,7 @@
376385
"name": "python",
377386
"nbconvert_exporter": "python",
378387
"pygments_lexer": "ipython3",
379-
"version": "3.6.4"
388+
"version": "3.6.5"
380389
}
381390
},
382391
"nbformat": 4,

assets/good_code.png

38.2 KB
Loading

0 commit comments

Comments
 (0)