fneum / data-science-for-esm

https://fneum.github.io/data-science-for-esm/intro.html
MIT License
70 stars 36 forks source link

Educators Build Your Own Content - the OET Team #20

Open mdzzg opened 4 months ago

mdzzg commented 4 months ago

Dear Fabian,

I am sending a PR, with the new Educators content, added as the as the ultimate chapter, to the pre-exisitng material (as instructed by @pz-max ): link!

This is a joint effort by @ekatef @pz-max @danielelerede-oet @mdzzg, the idea is by @pz-max , where I am just the executor (with some skills 😉 @ekatef).

The material itself is on building a Github Page, alike yours, from a Jupyter Book using the deploy workflow, i.e. gh-actions.

  1. The Educators content is split up into the intro chapter + 8 foldable, accordingly titled, sections, and added, as aforementioned, as the final part of the Data Science course.

  2. _toc.yml has been modified accordingly, incorporating the new content, and following the new folder structure:

    • Data Science content is located in the: data-science-for-esm/content/
    • Educators content is placed in the: data-science-for-esm/BYOC/
  3. The figures used in the Educators material, + the website TUB logo, have been placed in the data-science-for-esm/_images/ folder , in order to avoid clutter, and simplify for the new users:

    • my suggestion here would be doing the same for the remainder of the .png files of this repo, again for simplifying things for the new users,
    • you will notice I placed both the pypsa_logo.png and the buses.png in the _images/ folder, but I did not want to change any of the cross-referencing for them in your Notebooks, on my own, without any prior approval,
    • I believe grouping all of these images, and ATM there are rougly 10 of them in the repo, would simplify the meintanance & usage.
  4. README.md has a styling upgrade:

image

  1. With the added content, the github.io now looks like this, with the red sqare indicating the new material:
    • As previously stated, the website itself is available for your inspection at the following link!

image

I am happy to continue discussing the above, hopefully an expecting and a welcoming, PR here, at a time of your convenience.

Until then , With our best regards , The OET Team

P.S. @fneum Please keep the entire team:

With thanks!