dhruvbhagtani / EMSC-8033-project

Project for EMSC-8033 class, semester 1, 2021.
GNU Lesser General Public License v2.1
0 stars 0 forks source link

Commenting notebooks #6

Closed navidcy closed 3 years ago

navidcy commented 3 years ago

The comments in the notebooks are thorough. But they don't describe the actual numerical methods used. In that respect, I it's questionable whether the notebooks, at their current form, can be used as a Tutorials for Finite Difference methods to someone that hasn't been indoctrinated into these methods previously.

Hm... on second read, making Finite Difference Tutorials is not what your project plan argues you went on to achieve. But I had somewhere in my head this as the project's goal -- I don't remember why. Perhaps my bad.

navidcy commented 3 years ago

Still, my remark holds. The notebooks are a bit under commented. It would be much better if the notebooks didn't try to achieve as much but focused on being more pedagogical to the user.

I guess, the direction you took upon was not to create some pedagogical notebooks for users but rather to press on with this project as part of your bigger PhD project. This is fair, but at the end of the day the class was more about producing a self-contained product, piece of code. I'm not sure we managed to communicate this to all... :(

dhruvbhagtani commented 3 years ago

Yes, making finite difference tutorials was a part of my project plan, to which I don't think I gave proper justice. I agree, the notebooks are reasonably commented, but definitely can't be used as finite difference tutorials.

Also, you're right, this project looks like I was trying to make it a part of my PhD project. To be very honest, I tried killing two birds with a stone.

navidcy commented 3 years ago

In three weeks, sometimes, killing two birds with one stone could be challenging. 😊

dhruvbhagtani commented 3 years ago

I definitely learnt this from the project.