kangwonlee / tutorial

Short Introductions of bash, git, python, and jupyter notebooks

Hi there 👋

tutorial's Issues

Markdown Version

650aa79

• Sometimes rendering .ipynb may need more response time than some desirable level
• Descriptions → .md
• Exercises → .ipynb

rel / abs path

650aa79

rel path
abs path

ls ../folder/main.py
python  ../folder/main.py

Windows test does not pass

Symptom

• As of 56f6c5f
• Since build #44
• Goes overtime (>40 min)
• For now, allow Windows tests to fail

Action plan

• Compare raw logs of build #48 Linux vs Windows
• Check which test of Windows did not pass == test that took too long
• Run that test with stdout capture

branch instructions seem duplicated

• Some instructions on the branch seems duplicated
• Consider to reconcile

More self sufficient instructions

Motivation

• If a student misses a step of an instructor, he/she may have hard time catching up

Action plan

• More step by step guide?

Continue markdown numbered list by indenting

• as of 7c28e61
• https://stackoverflow.com/questions/18088955/markdown-continue-numbered-list

need to choose envs to test

• As of be7d6c4

python	anaconda	os
3.5	4.2.0 2016.09	linux, osx, windows
3.6	5.0.1 2017.10	linux, osx, windows
3.7	5.3 2018.09	linux, osx, windows
3.7.1	2018.12	linux, osx, windows
3.7.3	2019.03	linux, osx, windows
nightly	nightly	linux, osx, windows

• Let's just keep

python	anaconda	os
3.7	5.3 2018.09	linux, osx, windows
3.7.3	2019.03	linux, osx, windows
nightly	nightly	linux, osx, windows

Add exercises to Jupyter notebook tutorial

• on top of 95b5fde
• kangwonlee/2018pycpp#11 && kangwonlee/nmisp#51
• executable examples?
• Cell addition?

push skip-if to test_ipynb

• as of 1bb2b8d
• pushed to test_ipynb kangwonlee/test_ipynb@a92c1e3

Continue markdown numbered list across cells

• git practice instructions may include cells in between
• Is continually increasing the numbering possible? Otherwise adding or deleting an instruction can be too time consuming

MS VS Code : running one line -> python shell

• Unintentionally may use that command instead of Run script in terminal right above
• To exit, exit()

MS VS Code Tutorial

• Consider MS VS Code tutorial
• kangwonlee/18pf_lpthw_template#30

Edit

• Ctrl+Click
• Ctrl+Alt+↓

Config

• Running & debugging

git merge / rebase conflict

kangwonlee/nmisp#117

conda

• conda list anaconda
• conda install anaconda=2019.07
• conda clean --auto
• conda init bash

jupyter notebook tutorial

• https://github.com/ipython/ipython-in-depth/tree/old-in-depth for now?
• forked to https://github.com/kangwonlee/ipython-in-depth/tree/old-in-depth
• kangwonlee/2018pycpp#11
• kangwonlee/nmisp#51

vi window command

• split horizontal :sp <filename>
• increase window size Ctrlw+
• decrease window size Ctrlw-
• maximize window size Ctrlw_
• equalize window size Ctrlw=
• split vertical :vsp <filename>
• switch between Ctrlw{h, j, k, l, ←, ↓, ↑, →}
• ref https://www.sourceallies.com/2009/11/vim-splits-an-introduction/

Test links in .md files

• Test if urls in .md files available
• https://github.com/kangwonlee/test_ipynb

jupyter notebook magic commands

• #10, #11

References

• https://www.dataquest.io/blog/jupyter-notebook-tips-tricks-shortcuts/
• https://ipython.readthedocs.io/en/latest/interactive/magics.html

Testing cache for Windows

• Hope to make Windows build faster
• kangwonlee/nmisp#42
• As of 71d687f, without cache, each Windows test takes about 10 minutes
• 3105b4f is trying to cache miniconda3 installation (about 14 minutes)
• With cache, 10m47s (total cache size maybe too big?)
• For ed8160a, building cache for Windows took more than 17 minutes

Jeremy Howard's git recommendations

https://twitter.com/jeremyphoward/status/1289982339829792769

git config --global pull.rebase true
git config --global rebase.autoStash true

Detect shell command error

• git checkout <invalid branch> does not raise an exception
• out = !git checkout <invalid branch> would capture the output error message but seems not exactly desirable as a tutorial
• %%script bash --out stdout --err stderr captures stdout and stderr respectively

References

• https://stackoverflow.com/questions/35857230/ipython-raise-exception-when-a-shell-command-fails
• https://jakevdp.github.io/PythonDataScienceHandbook/01.05-ipython-and-shell-commands.html
• https://ipython.readthedocs.io/en/stable/interactive/magics.html#cellmagic-script

Observation

• Following cell would raise an error

%%bash --out stdout --err stdout
git checkout <invlaid branch>

repl going backward

git conflict example

https://www.youtube.com/embed/inHd9P-YmkY&t=173

Advantage of using ipynb files here?

• Executable shell script examples?

More materials

Motivation

• A good introduction for students with possibly limited exposure so far

A possible action plan

• Updates from https://github.com/kangwonlee/2018pycpp/tree/master/00
• Updates from https://github.com/kangwonlee/nmisp/blob/master/A0_bash/00_bash.ipynb
• kangwonlee/nmisp#51 & kangwonlee/2018pycpp#11
• kangwonlee/2018pycpp#36 0369a36
• kangwonlee/18pf_lpthw_template#31 c787ac1
• kangwonlee/18pf_lpthw_template#33 1998443

A possible issue

• This also has C/C++ but not a must

<kbd>&uarr;</kbd>, <kbd>&darr;</kbd>, <kbd>Ctrl</kbd>+<kbd>r</kbd>

https://github.com/kpumecpf/2009class/issues/24