The idea for this repo

[StanczakDominik]

Hi everyone, I basically just found this repo today, and I'm not sure I was aware of it before or just forgot.

I think we need to talk about what the idea behind this is. It looks like people had different things in mind:

1. tutorials on how to use PlasmaPy, which seems reasonable to me and I think Create a tutorial for new users of PlasmaPy #11, Add tutorial on dispersion functions and dispersion relations #13, Add tutorial on Coulomb logarithms #15 and Tutorial example for cold plasma dielectric tensor elements #16 had this in mind
2. Sort of in-group tutorials for PlasmaPy developers on plasma physics and how to write Python - Created programing dir and put in the first tutorial! #2 seems to be this
3. Presentation materials for actual live tutorials on using PlasmaPy that we would eventually like to host at events like SciPy, universities etc

I would argue that 2 is:

1. out of scope, programming and learning resources are probably better shared on Riot or the mailing list (in fact, we probably should have a Resources thread there...)
2. confusing, as it introduces two actual places to submit tutorials - this repo and plasmapy/examples in the main repo, more on this in a while

If 3 is the case, then sure, this repo is useful but needs renaming and its purpose needs to be stated clearly.

If 1 is the case, we need to address the issue that having two separate places to submit examples/tutorials is terrible. I was thinking,

Wouldn't it be nice to have a separate repository for examples, so that CI doesn't have to build them on every commit and they don't slow down development?

But at the same time, doesn't that introduce terrible risk for each PR breaking existing examples?

I think this disadvantage outweighs the single "neatness" advantage.

Thus, I think the best way to proceed unless 3 is the case is to either:

1. finish and merge Tutorial example for cold plasma dielectric tensor elements #16
2. merge the example into PlasmaPy
3. close down this repository

or

1. reopen and merge Tutorial example for cold plasma dielectric tensor elements #16 into PlasmaPy instead
2. close down this repository

I'm gonna have a followup to this in a few minutes on the main repo...