PhET-iO instrumentation design plan

[jbphet]

Notes for 9/27/2018 meeting with @kathy-phet, @ariel-phet< @DianaTavares, @samreid, @chrisklus, @arouinfar, and myself.

The following items should be instrumented:

• [x] all buttons
• [x] all checkboxes
• [x] the slider
• [x] the cuing arrows (separate from the slider)
• [x] the B-G-R and star display should be instrumented as a single unit
• [x] the unit conversion on the x axis that says 1 um = 1000 nm
• [x] the control panel that contains the buttons and the check boxes
• [x] the "Graph Values" dot
• [x] the arrows associated with the "Graph Values" dot
• [x] the temperature readout
• [x] the "Blackbody Temperature" label
• [x] the thermometer as a whole
• [x] the benchmarks on the thermometer so that they can be turned off
• [x] the save key panel (shown when lines have been saved)
• [x] the spectrum
• [ ] saving the state, should include:
  • [x] temperature
  • [ ] from @chrisklus - slider?
  • [x] check box states
  • [ ] saved curves
  • [x] zoom levels
  • [ ] green dot state
  • [x] intensity (in W/m^2)

We discussed whether the values that are shown on the X and Y axes should be instrumented, thus allowing them to be hidden. We decided against doing this, but would be willing to do it if a client requested this feature.

We also discussed whether to allow hiding of the curve, and decided against, but would add it if a client requested it.

[jbphet]

Our plan is to do this after the code review. I'll leave it unassigned for now, and will assign to @chrisklus when we're getting close on this.

[samreid]

Please see https://docs.google.com/document/d/1OfHhIDuaBt-hhXVtpnJgM3Wm0iByJ7dmXd-2UkphUR4/edit# for a reference of Graphing Quadratics PhET-iO design.

And see https://github.com/phetsims/phet-io/blob/master/doc/how-to-design-phet-io-features-for-a-simulation.md for instructions for how to design for PhET-iO.

[jbphet]

A few weeks ago we discussed whether this sim should go to RC with both PhET and PhET-iO brands. At the time, we decided to defer that decision until we were closer to publication. @chrisklus said that the instrumentation of the sim itself would not block the PhET-iO brand testing and publication, so it is the state of the common code and PhET-iO library code that would likely be the determining factor.

In the 5/16/2019 developer meeting, I said that I think this sim is about two weeks away from an RC, and asked if the PhET-iO code infrastructure was likely to be in a state where PhET-iO brand could and should be published. @pixelzoom pointed out that Graphing Quadratics is currently blocked from publishing PhET-iO brand due to several issues, including:

• common code needs to be updated such that some components are marked as "featured" by default
• studio has to be ready to go to support the specification of the blackbody-spectrum tandems
• the activity has to be done by the designers to actually specify blackbody-spectrum featured items

My impression from this discussion was that it is pretty unlikely that things will be in a state to support the simultaneous testing and release of the PhET and PhET-iO brands. My recommendation would be to plan to only go for PhET brand for the first release.

Assigning to @ariel-phet to see if he concurs. Tagging @arnabp and @kathy-phet so that they are aware and can comment if they feel the need.

[ariel-phet]

@jbphet @arnabp I concur. PhET-brand should be published without worrying about publishing an iO brand simultaneously.

[arnabp]

The sim was published without iO. Assigning to @chrisklus to take notice when the noted PhET-iO issues have been resolved to a state so the PhET-iO brand of blackbody can be published.