Edinburgh-Chemistry-Teaching / Data-driven-chemistry

Creative Commons Attribution 4.0 International
22 stars 2 forks source link

Unit_05 #3

Closed ppxasjsm closed 1 year ago

ppxasjsm commented 1 year ago

Also address issues from gitlab James had raised:

jasmin-guven commented 1 year ago
  • [ ] Update notebook to match style guide
  • [X] Move taks explantion to Unit_01 first notebook as it is true for all of the notebooks
  • [x] In particular:

    • [x] make sure corect f-string formatting is used
    • [x] spelling is correct
    • [ ] structure is easy to follow using the table of content (TOC)

Also address issues from gitlab James had raised:

  • [X] The learning outcomes should be phrased as "you will be able to XXX" rather than "you will learn XX". At the moment they are quite vague.

Changed to include parts of the "today's plan" section

  • [X] I like the NumPy figures, but it would be better if they used np rather than numpy

I've replaced this with a markdown code example

  • [X] for next year, we should consider updating to use np.default_rng

I've updated this

  • [X ] Do we need to teach pint and units? It doesn't really match the learning outcomes of the course (and should be covered in labs) -> migrate this to an extra notebook? I think it is useful to have, but yes it is not part of the original

Moved to storing.ipynb for now.

  • [ ] For the sub/superscripts, maybe also teach how to do it in MarkDown.

There is a question about what is the difference between tuples, lists and arrays that's referenced from geeksforgeeks. Where should we put this?

This is still WIP.

jasmin-guven commented 1 year ago

I've finished editing the notebook to fit the style guide.

I would suggest moving the error discussion from this unit to the first part of unit 1. What does everyone think?

punkpony commented 1 year ago

@jasmin-guven

Error discussion: I would not move things about, cause we risk loosing logical links/creates unnecessary work. Tuple/lists/.. - it was there as a reminder Q, so I would not move it either

James' comment about the units - it has been there in the v. 2021/22. It is still useful info, and it is also important for students to know to check their units/ to comment it somewhere, not just assume everything is naturally in SI units. The pint practice can be a separate notebook.

degiacom commented 1 year ago

Currently the two main notebooks in The Unit_5 are called Unit_05_plotting_Iand Unit_05_plotting_II. Considering that the former does not feature any plotting at all, I suggest file names should be changed. How about Unit_05_numberical_data and Unit_05_plotting?

degiacom commented 1 year ago

For clarity, I suggest to prepend Extra_* to the file names of Jupyter notebooks not part of the material directly taught in the unit, as done in Unit_06 (if everybody agrees that this material should stay in Unit 5).

ppxasjsm commented 1 year ago

I like the Extra_* idea. Also naming makes sense, there was not much thought behind it other than all the notebooks were very long and splitting thins up will make it easier. The same will apply to a bunch of other Units too.

degiacom commented 1 year ago

Not sure what to do with the notebook units_scientificnotation.ipynb. Does not fit in the Unit topics, but can be useful to talk about that somewhere. Clean and convert into Extra* too?

ppxasjsm commented 1 year ago

This seems to be done now, thanks @degiacom for having a pass through it!