App structure

[lheagy]

In order to have consistent structure to the apps, I think we should try to agree on a common skeleton for all of the apps (note that not all will be formatted correctly yet...). For the em-apps, we had agreed on:

• Title
• Purpose : Motivation and key concepts addressed by the notebook
• Setup : Overview of the relevant parameters in the problem
• Questions : Guiding questions related to the purpose
• App : interactive visualizations
• Explore : further questions that can be explored with the app
• (Additional material: supporting derivations, links to related case studies, ...)

However, in practice, we tended to move the "questions" and the "explore" to the gpg, em-geosci, or the lab / assignments. In order for the apps to remain a bit more general and applicable across multiple courses, we might want to consider continuing this practice, in which-case, what do you think of the following structure

• Title
• Purpose : Motivation and key concepts addressed by the notebook. Includes links to relevant background material / extra questions in em geosci / gpg
• Setup : Overview of the relevant parameters in the problem
• App : interactive visualizations
• (Additional material: supporting derivations, links to related case studies, ...)

Thoughts? cc @yangdikun, @dougoldenburg, @jiajiasun

[jiajiasun]

Hi, @lheagy I like the structure you proposed. It is pretty much what I did when I was designing the apps for my EM course. One thing that I did differently is that, I have ~10 tasks/questions for students to complete, right after each app. (I did this only because the app was meant to serve as homework for students to finish.) For our purpose here, we probably do not need to include these tasks/questions. So, what you proposed is great!

I also have an acknowledgment at the end of each app, to acknowledge help from SimPEG team. I do not know if this is something worth having in the geosci apps or not.

[lheagy]

Thanks @jiajiasun, I really like the idea of an acknowledgement at the end of each app. We could potentially also include a creative commons license badge to indicate to others that they can use and adapt the material

[yangdikun]

Title, purpose, setup, app - good!