Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Don't use bash magics in Jupyter lesson #64

Open
bast opened this issue Sep 14, 2020 · 5 comments
Open

Don't use bash magics in Jupyter lesson #64

bast opened this issue Sep 14, 2020 · 5 comments

Comments

@bast
Copy link
Collaborator

bast commented Sep 14, 2020

Does not work for some learners on windows and they might think that all magics won't work.

@rkdarst
Copy link
Member

rkdarst commented Sep 14, 2020 via email

@bast
Copy link
Collaborator Author

bast commented Sep 14, 2020

the matplotlib one is important and i will show it later

@annefou
Copy link
Collaborator

annefou commented Sep 14, 2020

matplotlib + timeit

or/and mention
%prun, %lprun, %memit, %mprun

rkdarst added a commit that referenced this issue Nov 6, 2023
- Related: #64 (makes it slightly bettter but not fully fixing)
- Introduce %%timeit as first magic since %%bash doesn't work on all
  OSs.
- Not yet removing %%bash, I'd like to add another magic as an extra
  example to not make it just about %%timeit
- I think that %%prun is most likely option for another demo but it
  should have a longer example that gives a meaningful profile.
@tpfau
Copy link
Member

tpfau commented Nov 7, 2023

Bumping this.
Either remove completely or use exclusively magics which are built-in and not OS dependent.
E.g.

%%bash

requires a unix system.
timeit should be ok.

@bast
Copy link
Collaborator Author

bast commented Nov 7, 2023

Please really avoid having bash magics in the material. Otherwise instructors will show them and it won't work for 50% of the learners who are on Windows.

Notebooks that use bash magics are often less reusable and less movable to other machines. Often they try to do something with the file system which might not be present at the other computer that tries to run this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants