Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write implementation-notes.md #95

Closed
AgustinVallejo opened this issue Feb 10, 2025 · 7 comments
Closed

Write implementation-notes.md #95

AgustinVallejo opened this issue Feb 10, 2025 · 7 comments
Assignees

Comments

@AgustinVallejo
Copy link
Contributor

Related to #93

JB already did some work and I will continue.

@AgustinVallejo AgustinVallejo self-assigned this Feb 10, 2025
@AgustinVallejo AgustinVallejo mentioned this issue Feb 10, 2025
89 tasks
@jbphet jbphet mentioned this issue Feb 14, 2025
88 tasks
@marlitas
Copy link
Contributor

marlitas commented Feb 14, 2025

Review Comments Part 1:

  • I'm assuming you meant to link to the Quantum design doc instead?

* [Models of the Hydrogen Atom HTML5](https://docs.google.com/document/d/1fZT_vDD8sX8nkSpTxHOyoP6-XrAIJYo44dacLIbZO14/edit?pli=1&tab=t.0) (Parts of this are likely to be stale.)

  • The Bloch Sphere section could use a bit more context and explanation. Mostly
    • I am unsure what is important for me to track because of the code and what pedagogically important. Perhaps it's both, but as a developer and/or maintainer I'm more interested in the former.
    • In AbstractBlochSphere you have the sentence They are related but will be linked in the implementations. I don't understand what is related and how it will be linked. That sentence is providing more confusion than clarity. If it's not important I would suggest to leave it out.
    • I would replace Same as above with Same as BlochSphereNode for clarity. That also doesn't lock you into that exact list order in case you add or change something.

@jbphet
Copy link
Collaborator

jbphet commented Feb 14, 2025

@AgustinVallejo - I've taken a shot at the initial version of this document, see https://github.com/phetsims/quantum-measurement/blob/main/doc/implementation-notes.md. I tagged you at two places (search for "Agustin") for parts that I think you might want to enhance. Also, the comments from @marlitas above are mostly about a Bloch sphere section that I copied and pasted from your Slack doc, so you can probably best address those. Assigning to you for next steps.

@jbphet jbphet assigned AgustinVallejo and unassigned jbphet Feb 14, 2025
AgustinVallejo added a commit that referenced this issue Feb 15, 2025
@AgustinVallejo
Copy link
Contributor Author

I did some improvements on the documentation.

I am unsure what is important for me to track because of the code and what pedagogically important

Perhaps we can talk on monday so this is clearer among us and in the docs.

@marlitas marlitas self-assigned this Feb 21, 2025
@marlitas
Copy link
Contributor

I'm going to do one last pass tomorrow before signing off.

@marlitas
Copy link
Contributor

Did you mean to say disseminated here?
These collections are created at startup but populated and decimated during the sim

marlitas added a commit that referenced this issue Feb 21, 2025
@marlitas marlitas removed their assignment Feb 21, 2025
@marlitas
Copy link
Contributor

Done. Over to @AgustinVallejo and @jbphet!

@AgustinVallejo
Copy link
Contributor Author

Thanks Marla!! Closing now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants