Some extra categorization of examples and tutorials

[navidcy]

Not sure exactly where we should put this, but I thought we have somewhere an extra categorization for the examples so that new users have an idea where to start from. E.g., some of the examples there are quite involved (I personally can't follow them) while others are pretty straight forward. So I was thinking we have something like:

• New users should first start from the Tutorials and in particular first with :

  • How to use cookbook
  • Exploring cookbook
  • Model agnostic
  • Maps

• From the Documented examples these are a bit more simpler (and novice users are urged to look at them)

  • Age_at_the_Bottom.ipynb
  • Annually_Averaged_Scalar_Timeseries.ipynb
  • Barotropic_Streamfunction.ipynb
  • Bathymetry.ipynb
  • Compare_SSH_model_obs.ipynb
  • Compare_SST_SSS_TemperatureSalinity_to_WOA13.ipynb
  • Meridional_heat_transport.ipynb
  • Model_Resolution_Comparison.ipynb
  • Querying_Scalar_Quantities.ipynb
  • Spatial_selection.ipynb
  • TemperatureSalinityDiagrams_mom5_mom6.ipynb
  • Transport_Through_Straits.ipynb
  • True_Zonal_Mean.ipynb
  • Zonally_Averaged_Global_Meridional_Overturning_Circulation.ipynb
  • Zonally_Averaged_Wind_Stress.ipynb

• while the ones below are a bit more involved:

  • Atlantic_IndoPacific_Basin_Overturning_Circulation.ipynb
  • Binning_transformation_from_depth_to_potential_density.ipynb
  • Cross-contour_transport.ipynb
  • Cross-slope_section.ipynb
  • Decomposing_kinetic_energy_into_mean_and_transient.ipynb
  • Equatorial_thermal_and_zonal_velocity_structure.ipynb
  • Particle_tracking_with_Parcels.ipynb
  • Regridding.ipynb
  • RelativeVorticity.ipynb
  • SeaIceSeasonality_DFA.ipynb
  • IcePlottingExample.ipynb
  • Surface_Water_Mass_Transformation.ipynb
  • TemperatureSalinityDiagrams.ipynb

Please did the list I made.. I didn't pay too much thought on it... I may have misplaced an example!

There was a discussion during the hackathon about having the ability to add keywords (@aidanheerdegen, @angus-g, @micaeljtoliveira). If that can happen then we can just add a "simple" / "elaborate" keyword or something?

[navidcy]

cc @adele157, @aekiss, @julia-neme, @lidefi87, @PaulSpence

[aidanheerdegen]

Also I'd suggest moving Spatial_selection.ipynb to tutorials to reflect their intent as general teaching rather than example scientific analysis. Maybe also Regridding.ipynb and IcePlottingExample.ipynb.

[navidcy]

Good points

[lidefi87]

If keywords do not work, then we can set a README with different categories, similar to this. We could even add a short description to each notebook. This option will take a bit of time now, but for future contributions, we could request this information to be provided already.

[navidcy]

Should we do some of this reorganization as part of the Hackathon v3.0? I think we should.

[navidcy]

At this point I suggest instead of implementing keyword features and what not (which I don't know what to do) we just split the Documented Examples to two categories "Basic" and "Bit more elaborate" and we have a blurb above to explain that novice users are urged to go through the basic examples first.