Renaming Example notebooks

[adele-morrison]

Many of the Example notebooks don't have very obvious names for what they do. And some of them could be simplified. I propose we rename a bunch of them. Here are some first suggestions, please comment if you have better suggestions.

Note these have been edited to include suggestions from comments below.

• Rename Zonally_Averaged_Global_Meridional_Overturning_Circulation.ipynb to just Meridional_Overturning_Circulation.ipynb. [Also, as an aside, I think we could absorb Atlantic_IndoPacific_Basin_Overturning_Circulation.ipynb into this notebook.]

• Rename Age_at_the_Bottom.ipynb. The important thing this notebook does is not showing age. It's the technique to extract the bottom most grid point of any variable that's what is useful. Rename to Extract_Variables_at_Ocean_Bottom.ipynb.

• Rename Barotropic_Streamfunction_model_agnostic.ipynb to Barotropic_Streamfunction.ipynb. I thought the idea is we're converting everything to be model agnostic, so not sure this needs to be in the title?

• Leave Bathymetry.ipynb as is? I still feel like it could be nice to indicate the main point of this notebook is to do a fancy projection and add coloured land. Plotting just bathymetry is pretty straighforward. Bathymetry_with_Pretty_Land.ipynb?

• Binning_transformation_from_depth_to_potential_density.ipynb rename to Transformation_from_Depth_to_Potential_Density.ipynb. Or Vertical_Coordinate_Transformation.ipynb.

• Rename Decomposing_kinetic_energy_into_mean_and_transient.ipynb to Eddy-Mean_Kinetic_Energy_Decomposition.ipynb

• Rename NearestNeighbourDistance.ipynb to Nearest_Neighbour_Distance.ipynb

• Rename Regridding.ipynb to Horizontal_Regridding.ipynb

• Rename SeaIceSeasonality_DFA.ipynb to Sea_Ice_Duration_Statistics.ipynb. I'm not sure what DFA is?

• Rename SeaIce_Obs_Model_Compare.ipynb to Sea_Ice_Area_Concentration_Volume_with_Obs.ipynb

• Rename SeaIce_Plot_Example.ipynb to Sea_Ice_Coordinates.ipynb

• Rename TemperatureSalinityDiagrams_mom5_mom6.ipynb to Temperature_Salinity_Diagrams.ipynb

[AndyHoggANU]

Yes, agree more useful names are good in general

[navidcy]

I'm all in for better names. Note, not only the notebook filenames but also the title at the top of the notebooks!

Regarding names:

• Rename Zonally_Averaged_Global_Meridional_Overturning_Circulation.ipynb to just Meridional_Overturning_Circulation.ipynb ? [Also, as an aside, I think we could absorb Atlantic_IndoPacific_Basin_Overturning_Circulation.ipynb into this notebook.]

100% 👍🏼

• Rename Age_at_the_Bottom.ipynb. The important thing this notebook does is not showing age. It's the technique to extract the bottom most grid point of any variable that's what is useful. Rename to Extract_Variable_at_Bottom.ipynb or Extract_Bottom_Age.ipynb ?

I'd go for the slightly paraphrased: Extract_Variables_at_Ocean_Bottom.ipynb

• Rename Barotropic_Streamfunction_model_agnostic.ipynb to Barotropic_Streamfunction.ipynb ? I thought the idea is we're converting everything to be model agnostic, so not sure this needs to be in the title?

100% 👍🏼 I was thinking about this yesterday but didn't make the PR!

• Rename Bathymetry.ipynb to Bathymetry_with_Pretty_Land.ipynb?

It's a bit subjective whether it's pretty or not :) I find it pretty -- don't get me wrong. Let's leave this one as "Bathymetry". I think it's not that problematic...

• Binning_transformation_from_depth_to_potential_density.ipynb rename to Transformation_from_Depth_to_Potential_Density.ipynb ? Or Depth_to_Potential_Density_Transformation.ipynb ?

I like Transformation_from_Depth_to_Potential_Density or just Vertical_coordinate_transformation?

• Rename Decomposing_kinetic_energy_into_mean_and_transient.ipynb to Eddy_Kinetic_Energy.ipynb

How about Eddy-Mean_Kinetic_Energy_Decomposition?

• Rename Regridding.ipynb to Horizontal_Regridding_with_xesmf.ipynb

How about just Horizontal_regridding?

• Rename SeaIceSeasonality_DFA.ipynb to Sea_Ice_Advance_Retreat_Duration_Statistics.ipynb. I'm not sure what DFA is?

100% 👍🏼

• Rename SeaIce_Obs_Model_Compare.ipynb to Sea_Ice_Area_Concentration_Volume_with_Obs.ipynb

100% 👍🏼

• Rename SeaIce_Plot_Example.ipynb. The main point of this notebook is not the plotting, but the explanation of how to convert CICE variables into a format compatible with MOM output. Maybe Sea_Ice_Coordinate_Conversion_Explanation.ipynb ?

100% 👍🏼; perhaps @anton-seaice has a better view point?

• Rename TemperatureSalinityDiagrams_mom5_mom6.ipynb to Temperature_Salinity_Diagrams.ipynb

100% 👍🏼

[anton-seaice]

SeaIceSeasonality_DFA.ipynb to Sea_Ice_Advance_Retreat_Duration_Statistics.ipynb

DFA = Denise

I think Sea_Ice_Seasonality is fine, or Sea_Ice_Duration is also fine. You need Advance and Retreat to calculate Duration, so its kind of implied that is included. I wouldn't add "Statistics"

Rename SeaIce_Plot_Example.ipynb...

Maybe Sea_Ice_Coordinates is enough ?

NearestNeighbourDistance.ipynb annoys me ... can it be Nearest_Neighbour_Distance at least :)

[navidcy]

DFA

Oh we don’t want names on notebooks.

I actually thought it was something related with seasonality eg December-February-April but I never bothered thinking too much about it.

[navidcy]

SeaIceSeasonality_DFA.ipynb to Sea_Ice_Advance_Retreat_Duration_Statistics.ipynb

DFA = Denise

I think Sea_Ice_Seasonality is fine, or Sea_Ice_Duration is also fine. You need Advance and Retreat to calculate Duration, so it's kind of implied that is included. I wouldn't add "Statistics"

Sea_Ice_Seasonality_Statistics.ipynb 👍🏼

Rename SeaIce_Plot_Example.ipynb...

Maybe Sea_Ice_Coordinates is enough ?

Sea_Ice_Coordinates.ipynb 👍🏼

NearestNeighbourDistance.ipynb annoys me ... can it be Nearest_Neighbour_Distance at least :)

Nearest_Neighbour_Distances.ipynb ?

[adele-morrison]

I think Sea_Ice_Seasonality is fine, or Sea_Ice_Duration is also fine. You need Advance and Retreat to calculate Duration, so its kind of implied that is included. I wouldn't add "Statistics"

I don't know, when i think 'sea ice seasonality', I think of a climatological time series of extent. I think having at least Duration in there would be helpful.

Rename SeaIce_Plot_Example.ipynb...

Maybe Sea_Ice_Coordinates is enough ? 👍🏼

I'll edit the very top post here with the names we're converging to, so it doesn't get too messy.

[navidcy]

I may even add the rename

True_zonal_mean

to

Zonal_mean_in_tripolar_grids

or something even more generic?

I don't like the True... it's redundant. It's the true zonal mean but why we need to point it out. Except we wanna put this everywhere... True_AMOC, True_Meridional_Heat_Transport, ...

[navidcy]

I started a PR to work towards doing this renaming...