Beers Law Lab - PhET-iO redesign

[pixelzoom]

There are several open issues labeled with dev:phet-io that have been open for quite awhile, with no progress. Some have comments like "waiting until API redesign", e.g. #223 (comment). I'm responsible for this sim, and I don't like having things in a transient state for so long. So... I think we should redesign the PhET-iO API for this sim "soon", and get these issues resolved.

Assigning to @ariel-phet to prioritize.

[pixelzoom]

To do this redesign, we'll need to know what features clients are currently using, so that we don't remove something that is being used. @samreid @zepumph how do we determine this?

[samreid]

@kathy-phet is aware of how clients are leveraging some of the simulations, and it would be good for her to attend the design meetings.

[zepumph]

phetsims/sun#405 will need to be addressed for this too.

[pixelzoom]

From #230 - The concentration meter on the Concentration screen is the only readout that is currently instrumented. Decide whether to instrument other readouts similarly (AT detector, ...)

[pixelzoom]

• Decide how to form the tandem names for ComboBoxItemNode instances. This is currently a little awkward. Not sure whether to add "ItemNode" suffix, or store complete string (e.g. "drinkMixItemNode") as a field in the associated model element.

Example of what "field in the associated model element" might look like for BeersLawSolution.DRINK_MIX:

  BeersLawSolution.DRINK_MIX = new BeersLawSolution(
    'drinkMix',
    'drinkMixItemNode',  // tandem name used for ComboBoxItemNode 
    drinkMixString,
    BLLSymbols.DRINK_MIX,
    MolarAbsorptivityData.DRINK_MIX,
    new RangeWithValue( 0, 0.400, 0.100 ),
    ConcentrationTransform.mM,
    new ColorRange( new Color( 255, 225, 225 ), Color.RED )
  );

[samreid]

Having fully formed tandem components such as 'drinkMixItemNode' makes debugging and understanding a breeze. In places where we have tried things like element.tandemName+'ItemNode', it has been harder to understand and maintain. Tagging @zepumph in case he has additional thoughts.

[pixelzoom]

Adding "block-sim-publication" label because this sim is still in a sub-standard state.

[pixelzoom]

#262 (clean up PhET-iO implementation) is a prerequiste to this issue.

[pixelzoom]

Status for 1/4/2022 quarterly-planning meeting:

Status is unchanged from the previous quarterly-planning meeting. There are several issues that need to be fixed (estimate: 2-3 weeks), and PhET-iO re-design needs to be done.

[pixelzoom]

I've gone through the sim, and taken my "best guess" at revising the instrumentation for modern PhET-iO standards. @arouinfar opened #296 which seems like a duplicate of this issue. So I'll close this issue, and we can review in #296.