phetsims / acid-base-solutions

"Acid-Base Solutions" is an educational simulation in HTML5, by PhET Interactive Simulations.
http://phet.colorado.edu/sims/html/acid-base-solutions/latest/acid-base-solutions_en.html
GNU General Public License v3.0
4 stars 7 forks source link

examples.md #191

Closed pixelzoom closed 1 year ago

pixelzoom commented 1 year ago

I'll create an empty examples.md, then assign to @arouinfar to populate.

pixelzoom commented 1 year ago

The empty examples.md is https://github.com/phetsims/phet-io-sim-specific/blob/master/repos/acid-base-solutions/examples.md

pixelzoom commented 1 year ago

From https://github.com/phetsims/acid-base-solutions/issues/178#issuecomment-1360622707:

  • [ ] Some views are optimized to update only when they're visible, so will not be in sync with the model when invisible. Is that a problem for PhET-iO? This includes:
    • PHPaperNode color
    • MagnifyingGlassNode particles
    • ConcentrationGraphNode bars and values

We decided that this was OK, and necessary to keep the sim responsive. But it should be mentioned in examples.md.

pixelzoom commented 1 year ago

Strong acids and bases are modeled as having constant strength. The value is arbitrarily chosen to be 101. It only needs to be greater than the maximum strength of weak acids and bases.

pixelzoom commented 1 year ago

All non-Water solutions in the Intro screen have concentration 1E-2. You'll need to change each solution individually if you want them all to be the same. The elements are:

acidBaseSolutions.introductionScreen.model.solutions.strongAcid.concentrationProperty acidBaseSolutions.introductionScreen.model.solutions.strongBase.concentrationProperty acidBaseSolutions.introductionScreen.model.solutions.weakAcid.concentrationProperty acidBaseSolutions.introductionScreen.model.solutions.weakBase.concentrationProperty

arouinfar commented 1 year ago

Thanks for adding this information @pixelzoom! I'll use this comment to keep a running list of additional things to document.

Tagging #190 so this issue shows up there.

arouinfar commented 1 year ago

I've completed a first draft of examples.md. @Nancy-Salpepi can you please take a look and let me know if you have any recommendations?

Nancy-Salpepi commented 1 year ago

Examples look good @arouinfar!

If there are values you want to be kept constant, use visibleProperty to hide the control or enabledProperty to disable it.

Maybe change the wording at the beginning of this sentence? "If you want to keep certain values constant..."

arouinfar commented 1 year ago

Thanks for your feedback @Nancy-Salpepi. I've made the requested changes in the above commit. The examples doc is now complete, closing.