OGGM / tutorials

Notebook tutorials for the Open Global Glacier Model (OGGM)
https://tutorials.oggm.org
BSD 3-Clause "New" or "Revised" License
17 stars 18 forks source link

Improving tutorials for v1.6 (proposed roadmap: tags) #112

Open bearecinos opened 8 months ago

bearecinos commented 8 months ago

Hi everyone,

@ehultee, @suther11LBU and I, did a bit of gathering of thoughts on the tutorials (among other things) that we have encountered, I will try my best to summarise things in different issues. This issue being the most general one (more issues will come to document a road map in the different repositories).

General comments

We feel the tutorials ATM need to be organised in order to find quickly the information. We are sure that many things that we need are already there, but it does take a while for experienced users (like myself) to find stuff so it is not straight forward for undergrads. I propose (before suggesting new tutorials) .. that we make an organisation of existing tutorials and information.

Specific issues:

@ehultee: Edu material (apps, helper functions, etc) has become more abstract and slick, and core OGGM has become more technical. There is a missing middle. As a result, these resources do not work well together in the same educational setting. I taught students starting with edu notebooks, and it was a huge leap for them to understand what the real OGGM workflow was doing. I ended up doing a lot of troubleshooting for them when they worked with core OGGM.

fmaussion commented 7 months ago

Thanks for these comments. I finally found time to read and process them carefully and I agree with all of them.

They seems solvable relatively easily:

fmaussion commented 7 months ago

I don't think that such tags exist as of now, but I asked online: https://github.com/orgs/executablebooks/discussions/1128

With a little of book-keeping we could do our own structure by tag though.

fmaussion commented 7 months ago

I've tried something new here: https://oggm.org/tutorials/master/notebooks/welcome.html

I stopped the ordering between "beginner" and "advanced" which was very subjective anyways. I tried to order the notebooks via "themes". It's only a first step, perhaps we can work towards a better documentation over the next few weeks?

bearecinos commented 7 months ago

Hi, this looks way better! Happy to help organize on the next week!