PlasmaPy / SULI-2021

0 stars 1 forks source link

More general demo Binder repository? #1

Open pheuer opened 2 years ago

pheuer commented 2 years ago

I'm giving a tutorial on PlasmaPy (especially but not exclusively the HEDP diagnostics) in April, and I want to put together a repository of a few notebooks exhibiting:

This is very similar to the PlasmaPy/SULI-2021 repository. I could just copy that repo and make another one, but what if we changed the name of that into PlasmaPy/BinderDemo or something similar, with the intention of re-using it for different events? This would not be a duplication of the docs: there could be some explanation in the notebooks but the emphasis would be on allowing users to actually run the code and make changes themselves.

If too many notebooks are made, we can organize them in folders. And we can have a folder for workshop-specific notebooks in case we want to do something unique for a future workshop?

Paging @namurphy

namurphy commented 2 years ago

Yeah, I think a more general tutorial repository would be great! We could then either use that repo directly, or fork it for specific tutorials. It'd probably be worth considering what other packages do, like SunPy and Astropy. We do have an old repo called PlasmaPy-Tutorials which we might be able to use, though we could change it into something else.

There's also the possibility of using google collab instead of binder, or perhaps another online Python thing. I've been finding that binder can take a while to spin up an environment, and last I checked, there isn't any persistence between sessions unless someone downloads their notebook.

pheuer commented 2 years ago

Astropy has a good tutorial repo. SunPy has one too, but it seems out of date.

I think the repo could be platform-agnostic between binder and collab. Binder has the benefit of not requiring an account (?) so it might make more sense for a quick demo, whereas collab might work better for something like the summer school?

pheuer commented 2 years ago

The PlasmaPy-Tutorials repo looks like it was intended to be more tutorials for contributors?

I'd propose we create a new repo PlasmaPy-Demos, or rename this SULI-2021 repo and use this as the start of that new repo?