PhET-iO instrumentation

[pixelzoom]

In 12/21/2015 email, @ariel-phet wrote:

Kathy and I just discussed, and here is the current thought:

When Sam give's the green light that together is in a good place, we would like you to work on outfitting the first screen of Hooke's Law. Kathy was thinking about 10 hours of your time, so if outfitting goes quickly, feel free to go further in the sim, but with the first screen as the clear goal. If outfitting does not go quickly (obvious possibility), lets touch base as to progress after 10 hours.

[pixelzoom]

I'd like to see these issues addressed before this work proceeds:

• odd tandem for CuvetteNode beers-law-lab#129
• when is tandem.addInstance required? beers-law-lab#131
• why doesn't EyeDropperNode register its tandem? beers-law-lab#133

(NOTE: All the of the above have been addressed and closed.)

[pixelzoom]

At 1/7/16 status meeting, this task was deferred indefinitely.

[pixelzoom]

This is back on, assigned to @samreid and me to work on. @kathy-phet is getting info on what needs to be instrumented.

[pixelzoom]

I did a few things to prepare for instrumentation: #48, #49, #50, #51.

@samreid let me know if there's any other "general" things that I should consider.

[samreid]

Instrumentation looks like it is going well so far--I'm around for a while if you'd like me to tag along.

[kathy-phet]

Is Chris doing this then? K

…

Sent from my iPhone On Jun 7, 2018, at 5:37 PM, Sam Reid <notifications@github.com<mailto:notifications@github.com>> wrote: Instrumentation looks like it is going well so far--I'm around for a while if you'd like me to tag along. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub<#38 (comment)>, or mute the thread<https://github.com/notifications/unsubscribe-auth/AE3FZA-jEm5ctqC_xfVDRWyzOakXklLHks5t6Z0PgaJpZM4G5biW>.

[pixelzoom]

Basic instrumentation is done (tandems propagated). Ready to instrument specific Properties, etc. when @kathy-phet provides requirements.

[samreid]

For labeled UI components, I'd recommend naming the tandem to match the english text that appears on the label. For instance, the top radio button is labeled "Bar Graph", but the tandem is energyBarRadioButton--it should be barGraphRadioButton. This may include renaming vars or (lowercase) properties to match the tandems, where appropriate.

Also, I've committed initial work to phet-io-wrapper-hookes-law-energy, please be aware of the work there and update/change phetioIDs if they are changed in the simulation.

[pixelzoom]

I renamed tandems, types and enums to match the labels that appear on controls. For example, for the "Force Plot" radio button, the tandem is now "forcePlotRadioButton", the enum value is "forcePlot", and the type is ForcePlot. I did this for the "Bar Graph", "Energy Plot" and "Force Plot" radio buttons. I review all calls to createTandem and didn't see any other cases where this needed to be done. @samreid feel free to take a peek.

[pixelzoom]

In the above commit, I instrumented the model Properties in RoboticArm and Spring. Questions and concerns for @samreid to review:

• After doing this, phet-io-wrapper-hookes-law-energy now fails with Assertion failed: cannot start event while event is in progress when dragging either the arm or the displacement slider.

• Check my use of the units option.

• I was unclear on how to instrument DerivedProperty. Looks like phetioType is required, but there was nothing to validate that, and omitting resulted in a hard failure, see failure to check phetioType in PhetioObject tandem#56. Did I end up doing this correctly?

• Is the convention to group phet-io modules with a // phet-io modules comment? I looked for examples, but didn't see any consistent pattern. See https://github.com/phetsims/phet-io/issues/1331
  (EDIT: Convention is now // ifphetio.)

[samreid]

After doing this, phet-io-wrapper-hookes-law-energy now fails with Assertion failed: cannot start event while event is in progress when dragging either the arm or the displacement slider.

Tracked in #52, and another solution is in place, see phetsims/tandem#57

Check my use of the units option.

Usage of units looks good, and appears properly in studio.

I was unclear on how to instrument DerivedProperty. Looks like phetioType is required, but there was nothing to validate that, and omitting resulted in a hard failure, see phetsims/tandem#56. Did I end up doing this correctly?

Work is being done in phetsims/tandem#56

Is the convention to group phet-io modules with a // phet-io modules comment? I looked for examples, but didn't see any consistent pattern. See https://github.com/phetsims/phet-io/issues/1331
(EDIT: Convention is now // ifphetio.)

Addressed as described in preceding comments.

[pixelzoom]

Further work on instrumentation has moved to #58.

Closing.