CLIMADA-project / climada_petals

See https://github.com/CLIMADA-project/climada_python first
GNU General Public License v3.0
22 stars 13 forks source link

Remove content tables and update tutorial files #125

Closed luseverin closed 4 months ago

luseverin commented 5 months ago

In relation to #862 and associated PR #872, this PR removes content tables from CLIMADA tutorials. Changes proposed in this PR:

This PR fixes #862.

PR Author Checklist

PR Reviewer Checklist

luseverin commented 5 months ago

Following our discussion on https://github.com/CLIMADA-project/climada_python/pull/872

I had a brief check at the other tutorials and I also noted that some cells are failing to run in the climada_hazard_entity_Crop.ipynb. Are you aware of this?

I just wanted to point out the errors in theclimada_hazard_entity_Crop.ipynb tutorial. Should I open an issue for this?

chahank commented 5 months ago

Following our discussion on CLIMADA-project/climada_python#872

I had a brief check at the other tutorials and I also noted that some cells are failing to run in the climada_hazard_entity_Crop.ipynb. Are you aware of this?

I just wanted to point out the errors in theclimada_hazard_entity_Crop.ipynb tutorial. Should I open an issue for this?

Can you directly see why? If yes, maybe we can fix it. If not, yes please open an issue. Thanks!

chahank commented 5 months ago

Thanks @luseverin . It seems though that it did not yield the desired result for the open street map tutorial and the river flood tutorial.

luseverin commented 5 months ago

Oh ok it seems that some garbage output from when I re rendered the notebook was included in the commit. @chahank you are referring to this, right? If yes, I will remove this from the commit.

chahank commented 5 months ago

hmmm maybe? I am mostly referring to the fact that the table of contents for these two tutorials is not correct.

luseverin commented 5 months ago

So I have removed the "outline" and "how is this tutorial structured" parts in https://github.com/CLIMADA-project/climada_petals/blob/develop/doc/tutorial/climada_exposures_openstreetmap.ipynb and https://github.com/CLIMADA-project/climada_petals/blob/develop/doc/tutorial/climada_hazard_RiverFlood.ipynb respectively. Isn't it what I was supposed to do?

Edit: Ok so you are referring to the table of contents that appear on the right side of the readthedocs, I understand now. I didn't see it in the notebook directly. I will have a look.

luseverin commented 5 months ago

Ok so I have fixed the broken headers in the open street map tutorial and the river flood tutorial. It seems to be working fine now, eventhough some of the lower-level headers in open street map tutorial are not appearing on the menu on the right..

Regarding the crop yield tutorial I do not manage to run the tutorial's notebook and do not know where the errors are coming from. There also seems to be a FIleNotFoundError.. I will raise an issue about this. Maybe someone who knows this module better can fix it..

chahank commented 5 months ago

Ok, thanks ! I think you can merge.