Skip to content

Commit 84474e0

Browse files
fix: add numpy install sections to L1-L4 answers, close TODO, tweak AGENTS.md
- Add the missing "Package installation" section (%%capture %pip install numpy) to L1, L2, L3 and L4 exercise answers, matching the L5 and tutorial lessons - TODO.md: mark the text-based notebooks section as achieved in August 2026 (classic .ipynb notebooks migrated to MyST text notebooks in PR #9) and cross out the completed items - AGENTS.md: fix the "files excluded from version control" section, which claimed venv/ and _build/ were git-ignored although no root .gitignore exists Co-authored-by: openhands <openhands@all-hands.dev>
1 parent 0a03af3 commit 84474e0

6 files changed

Lines changed: 37 additions & 7 deletions

File tree

AGENTS.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -176,9 +176,10 @@ Thank you! Please report it at https://github.com/MarinhoLab/OpenExecutableBooks
176176
- Example: `fix/typos-and-uk-english`, `feat/add-lesson6`
177177

178178
### Files excluded from version control:
179-
- `venv/` — Python virtual environment
180-
- `_build/` — Build artifacts
181-
- `basic_lessons/*.ipynb` — Generated at build time from `.md` files
179+
- `basic_lessons/*.ipynb` — Generated at build time from `.md` files (via `basic_lessons/.gitignore`)
180+
181+
There is intentionally no root `.gitignore`. If you create local `venv/` or `_build/`
182+
directories, keep them out of commits (e.g. via `.git/info/exclude`).
182183

183184
---
184185

TODO.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,19 @@ that properly shows the video but not the image.
1111

1212
## Text-based notebooks
1313

14-
- Converting from traditional Jupyter notebooks to text-based notebooks might be an interesting topic to explore. See
14+
**Done — achieved in August 2026.** The lessons were migrated from classic Jupyter
15+
notebooks to MyST text-based notebooks (`.md` with `{code-cell}` directives), stored
16+
under `basic_lessons/` (see [PR #9](https://github.com/MarinhoLab/OpenExecutableBooksRobotics/pull/9)).
17+
The items below are therefore no longer open:
18+
19+
- ~~Converting from traditional Jupyter notebooks to text-based notebooks might be an interesting topic to explore. See
1520
[link](https://myst-nb.readthedocs.io/en/latest/authoring/text-notebooks.html#authoring-text-notebooks). Classic notebooks
1621
store cell output on themselves, with implications on version control software. While classic Jupyter notebooks are more
17-
easily usable without extensions, `jupytext` seemingly allows for the conversions. See [link](https://jupyterbook.org/en/stable/file-types/myst-notebooks.html).
18-
- The so-called [paired notebooks](https://jupytext.readthedocs.io/en/latest/paired-notebooks.html) are possibly the solution.
22+
easily usable without extensions, `jupytext` seemingly allows for the conversions. See [link](https://jupyterbook.org/en/stable/file-types/myst-notebooks.html).~~
23+
- ~~The so-called [paired notebooks](https://jupytext.readthedocs.io/en/latest/paired-notebooks.html) are possibly the solution.
1924
Given that the latex macros sometimes do not render well in `jupyterlab`, this could become indirectly a solution.
2025
The latex support for `myst` is much less hacky, so it is likely that the notebooks exported from the text version
21-
are more likely to be compatible with `jupyterlab`.
26+
are more likely to be compatible with `jupyterlab`.~~
2227

2328
## Notes
2429

basic_lessons/lesson1_exercise_answers.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,12 @@ kernelspec:
1313
## I found an issue
1414
Thank you! Please report it at https://github.com/MarinhoLab/OpenExecutableBooksRobotics/issues
1515

16+
# Package installation
17+
18+
````{code-cell}
19+
%%capture
20+
%pip install numpy
21+
````
1622

1723
# Valid imports
1824

basic_lessons/lesson2_exercise_answers.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,12 @@ kernelspec:
1313
## I found an issue
1414
Thank you! Please report it at https://github.com/MarinhoLab/OpenExecutableBooksRobotics/issues
1515

16+
# Package installation
17+
18+
````{code-cell}
19+
%%capture
20+
%pip install numpy
21+
````
1622

1723
# Valid imports
1824

basic_lessons/lesson3_exercise_answers.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,12 @@ kernelspec:
1313
## I found an issue
1414
Thank you! Please report it at https://github.com/MarinhoLab/OpenExecutableBooksRobotics/issues
1515

16+
# Package installation
17+
18+
````{code-cell}
19+
%%capture
20+
%pip install numpy
21+
````
1622

1723
# Valid imports
1824

basic_lessons/lesson4_exercise_answers.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,12 @@ kernelspec:
1313
## I found an issue
1414
Thank you! Please report it at https://github.com/MarinhoLab/OpenExecutableBooksRobotics/issues
1515

16+
# Package installation
17+
18+
````{code-cell}
19+
%%capture
20+
%pip install numpy
21+
````
1622

1723
# Valid imports
1824

0 commit comments

Comments
 (0)