phetsims / build-a-nucleus

"Build a Nucleus" is an educational simulation in HTML5, by PhET Interactive Simulations.
GNU General Public License v3.0
0 stars 5 forks source link

Complete model.md and implementation-notes.md #94

Closed zepumph closed 1 year ago

zepumph commented 1 year ago

@Luisav1, this is a good thing to do while we are still in the thick of development. In general, model.md is more of a public-facing doc to describe how we implemented the physics. This is a great chance to note some of the shortcommings (like the beta decay of uranium for example) and other "hollywooding" we may have done. In implementation-notes, make sure to add any qualities or patterns or oddities that may assist the next person in maintaining the sim.

Thanks!

zepumph commented 1 year ago
Luisav1 commented 1 year ago
Luisav1 commented 1 year ago

Added points on special cases and 'hollywooding' done in commits above, with other notes too both in model and implementation-notes. @ariel-phet could you review these to make sure they're okay or let me know if you have any suggestions? Thanks!

ariel-phet commented 1 year ago

@Luisav1, a few questions/comments:

For model.md

I don't really have any comments on the implementation notes, as those tend to be a bit more developer focused, but reading through them, no issues stood out to me.

Luisav1 commented 1 year ago

For 3. I added that statement since I was trying to in a way justify the reason for the checkbox though checking back in the doc, it seems we only added it to orient that we are in the nucleus or to match BAA. image @ariel-phet Do you think that statement is not that necessary such that this is clear or should I reword it?

ariel-phet commented 1 year ago

@Luisav1 I think I would just reword the statement, something like "The electron cloud is provided as an option to help orient users that the nucleus is being constructed within the context of an atom"

Luisav1 commented 1 year ago

Reworded the electron cloud statement in the commit above and completed the model and implementation-notes after a review by @ariel-phet. Closing.