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

How to maintain separate repository with notebooks/binder/etc. #66

Open
klieret opened this issue Jul 25, 2022 · 6 comments
Open

How to maintain separate repository with notebooks/binder/etc. #66

klieret opened this issue Jul 25, 2022 · 6 comments

Comments

@klieret
Copy link
Member

klieret commented Jul 25, 2022

There is a separate repository (https://github.com/hsf-training/hsf_matplotlib_notebooks), soon to be transferred to this organization that contains pre-filled notebooks.

How do we maintain them in the future?

@amangoel185
Copy link
Member

There might be similar workflows in The Carpentries which we could look into!

@amanmdesai
Copy link
Contributor

I just had a thought about this issue:

We can perhaps use some tool that converts our markdown file into jupyter-notebook content?

For instance, this package converts jupyter notebook to markdown.
We could modify it to suit our requirement (markdown to jupyter notebook conversion)

@klieret
Copy link
Member Author

klieret commented Aug 16, 2022

nbonvert is pretty great :)

I'm more thinking of going the other way: If we want to have a completely pre-filled notebook (not sure if we want to, see survey picture below), then I think we should use Jupyter notebooks and build a website from them using jupyter book.

image

Maybe with the amount of code that's flung around in matplotlib the survey result doesn't really apply though (because that would be a lot of typing...)

@amanmdesai
Copy link
Contributor

Thats sounds good.

The analysis-essentials repo's advanced python module uses jupyter notebooks and website is generated from the notebooks for this particular topic (as far as I understand). We can use a similar kind of workflow maybe.

Regarding survey: I think that having pre-filled notebooks is better as that saves time.
(Also it may be possible to prepare an extra semi-filled notebook with some exercises [with hints] )

@GuillermoFidalgo
Copy link
Collaborator

GuillermoFidalgo commented Oct 1, 2022

In terms of having pre-filled notebooks I, it all depends on the workflow used.
If we are thinking about active training then having pre-filled notebooks will take away interest or motivation from students to pay attention.
If we are thinking of passive learning when students are reading the notes on their own, then prefilled notebooks provide an interactive environment with examples.

I believe we can keep the pre-filled notebooks if students ever want to see some solutions.

@stale
Copy link

stale bot commented Nov 30, 2022

This issue or pull request has been automatically marked as stale because it has not had recent activity. Please manually close it, if it is no longer relevant, or ask for help or support to help getting it unstuck. Let me bring this to the attention of @klieret @wdconinc @michmx for now.

@stale stale bot added the stale label Nov 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants