Skip to content

Commit 3376a92

Browse files
committed
Dev tools review
1 parent 4596f81 commit 3376a92

9 files changed

Lines changed: 45 additions & 21 deletions
128 KB
Loading
114 KB
Loading
123 KB
Loading
1.58 MB
Loading
1.02 MB
Loading
220 KB
Loading

docs/notes/dev-tools/google-colab/overview.qmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ When creating a new notebook, practice giving the document a title (e.g. \"My Fi
1313

1414
From any notebook, it is possible to create a new notebook, make a copy of the notebook, or download the notebook, using the \"File\" menu.
1515

16-
![Google Colab File menu](../../../images/colab-file-menu.png){.img-fluid style="max-height:350;"}
16+
![The File menu in Google Colab.](../../../images/colab-file-menu.png){height=350}
1717

1818

1919
::: {.callout-warning}
@@ -35,7 +35,7 @@ Recommended editor settings:
3535
+ **Enable code folding**: so you can focus on certain parts of the code, and make the code more manageable to navigate.
3636

3737

38-
![Recommended editor settings in Google Colab](../../../images/colab-settings.png){.img-fluid style="max-height:450;"}
38+
![Recommended editor settings in Google Colab](../../../images/colab-settings.png){height=350}
3939

4040
Remember to save your preferences before moving on.
4141

docs/notes/dev-tools/google-colab/table-of-contents.qmd

Lines changed: 30 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,48 +6,62 @@ The heading structure of your markdown cells will govern the document structure
66

77

88
```md
9-
# Section 1
9+
# Header 1
1010

1111
This is some text.
1212

13-
## Section 1.1
13+
## Header 2
1414

1515
This is some text.
1616

17-
## Section 1.2
17+
### Heading 3
1818

1919
This is some text.
2020

21-
### Section 1.2.1
21+
#### Heading 4
2222

2323
This is some text.
24+
```
2425

25-
### Section 1.2.2
26+
::: {.callout-tip title="Note"}
27+
You may need to place each of these headings in its own separate text cell, for the document outline to collapse properly.
2628

27-
This is some text.
29+
![Document outline in Google Colab.](../../../images/colab-document-outline-expanded.png){height=350}
30+
:::
2831

29-
# Section 2
3032

31-
This is some text.
33+
<!--
3234
33-
## Section 2.1
35+
```md
36+
# Header 1
37+
```
3438
39+
```md
3540
This is some text.
41+
```
3642
37-
## Section 2.2
43+
```md
44+
## Header 2
45+
```
3846
47+
```md
3948
This is some text.
49+
```
4050
41-
### Section 2.2.1
51+
```md
52+
### Heading 3
53+
```
4254
55+
```md
4356
This is some text.
57+
```
4458
45-
### Section 2.2.2
59+
```md
60+
#### Heading 4
61+
```
4662
63+
```md
4764
This is some text.
48-
4965
```
5066
51-
::: {.callout-tip title="Note"}
52-
You may need to place each of the headings in its own separate text cell, for the document outline to collapse properly.
53-
:::
67+
-->

docs/notes/dev-tools/index.qmd

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,22 @@ So you want to develop programs and applications in Python?
44

55
You'll need to familiarize yourself with a Python development environment. One of the hardest parts of computer programming can be installing the language, and getting up and running with local development tools. But we will help guide you through the process, and recommend using tools that offer a low learning curve for beginners.
66

7+
In Python, we have a general choice between two development environments: Python notebooks vs local development, each offering its own strengths and trade-offs. Ultimately we recommend Google Colab notebooks for their accessibility and ease of use for beginners.
78

8-
## Notebooks vs Local Development
9+
## Python Notebooks
910

10-
In Python, we have a general choice between two development environments: Python notebooks vs local development, each offering its own strengths and trade-offs.
11+
Python notebooks (\".ipynb\" documents) provide an easy and intuitive learning experience for beginners. They have code \"cells\" we can "play" to see the results and learn along the way. The integration of visual outputs along with code provides strengths in terms of presentation.
1112

12-
Python notebooks (\".ipynb\" documents) provide an easy and intuitive learning experience for beginners. They have code \"cells\" we can "play" to see the results and learn along the way. The integration of visual outputs along with code provides strengths in terms of presentation. Notebooks are also a popular choice among data science and machine learning practitioners, especially for quick prototypes, and rapid development. However for larger applications they might not be as suitable.
13+
![Python notebook with code input and dataviz output.](../../images/python-notebook-inputs-outputs.png){height=320}
14+
15+
16+
Notebooks are also a popular choice among data science and machine learning practitioners, especially for quick prototypes, and rapid development.
17+
18+
![Rising popularity of Python notebooks. Source: [GitHub Octoverse 2024](https://github.blog/news-insights/octoverse/octoverse-2024).](../../images/python-notebook-adoption-2024.png){height=320}
19+
20+
However for larger applications they might not be as suitable.
21+
22+
## Local Development
1323

1424
Local development environments are used primarily for software development purposes, and for larger-scale applications which may span across dozens of files. The local development environment involves command-line programming tools that can be tricky to install and configure for beginners. For some types of applications, such as web applications, local development may be the only suitable option.
1525

0 commit comments

Comments
 (0)