Skip to content

Commit 404d89e

Browse files
author
Margreet Docter
committed
extra intro
added notebook intro Laetitia
1 parent 7cd222a commit 404d89e

4 files changed

Lines changed: 596 additions & 10 deletions

File tree

book/Intro_to_Jupyter_Notebook.ipynb

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

book/Styleguide.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# styleguide (overall)
1+
# Styleguide (overall)
22

33
The overall structure of each experiment is BASIC:
44
- Background
@@ -54,7 +54,7 @@ Per section we have an:
5454

5555

5656

57-
# styleguide (per experiment)
57+
# Styleguide (per experiment)
5858

5959
## Layout:
6060
- accessibility code
@@ -67,7 +67,7 @@ Per section we have an:
6767
- images
6868
- fonts
6969

70-
## accessibility code
70+
## Accessibility code
7171
For accessibility each will start with a piece of code for the accessibility of the notebook (.ipynb file). You can adjust the width of the text with the function provided below.
7272
- You can toggle the auto-numbering of the sections in the outline toolbox (sidebar or topbar).
7373
- You can toggle the code line numbers in the dropdown menu of the "view" button in the topbar.
@@ -86,7 +86,7 @@ set_width(50)
8686

8787
```
8888

89-
## title, goal, structure
89+
## Title, Goal, Structure
9090

9191
The title starts with a single hashtag plus space. Later sub sections go with ##, ###, etc.
9292

@@ -106,7 +106,7 @@ In each assignment the estimated time you will spend per part is given. If you s
106106

107107

108108

109-
### subsections format
109+
### Subsections format
110110
- subsections start with ##
111111
- per subsection give an estimated time, indented in grey. Example: > <font color='grey'>⏳ Estimated time: 10 min</font>
112112
- we want as little cookbook recipe following as possible.
@@ -122,7 +122,7 @@ YouTubeVideo('RSAVxhfckII', width = 600, height = 450)
122122
```
123123

124124
<!-- #region -->
125-
### images
125+
### Images
126126

127127
Inserting an online image, in our case on an open gitlab repository is done with html code. Have a look at the code of this block, and you see:
128128
- '<img': start of image
@@ -136,7 +136,7 @@ Inserting an online image, in our case on an open gitlab repository is done with
136136

137137
<!-- #endregion -->
138138

139-
### fonts
139+
### Fonts
140140
you can make different color or size fonts:
141141
- first define the font color
142142
- then write the text, or even copy paste an icon
@@ -153,7 +153,7 @@ Example:
153153

154154

155155

156-
### Inserting student's images
156+
### Inserting own images
157157
In some cases an answer can be best illustrated with a picutre, either drawn or a photo taken from the setup, or oscilloscope screen, or screendump of the laptop. Then the following code is most udesfull, which need to be in two consecutive cells:
158158

159159
```python

book/intro.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
1+
```python
2+
3+
```
4+
15
<!-- #region -->
26
(intro)=
3-
# Welcome to the Template Book
7+
# Welcome to the Online Manuals of the NB2214 practicum
48

5-
This Teachbook is meant to be able to open all NB2214 Practicum manuals without having to open the jupyter notebook on your laptop. If you want to, you can still download this notebook and work offline.
9+
This Teachbook is meant to be able to open all NB2214 Practicum manuals without having to open the jupyter notebook on your laptop. If you want to, you can still download this notebook and work offline, which is mainly needed when connecting to equipment such as the ALPACA, or NIDAQ.
610

711
## Expected of you
812
homework = Background+Anticipate + Simulate

how_to_mirror.txt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
git clone --bare https://github.com/mwdocter/TeachBook
2+
3+
cd DATA_Margreet\EI_manuals
4+
5+
git push --mirror https://github.com/NB-TUDelft/Electronic_Instrumentation
6+
7+
## in anaconda window in data/electronic_instrumentation folder
8+
pip install -r requirements.txt
9+
10+
jupyter-book build .
11+
12+
#under github, Go to Settings → Pages
13+
#Under Build and deployment, set Source to GitHub Actions

0 commit comments

Comments
 (0)