Expanded selection of example apps and documentation

[mkhorton]

This issue will likely involve:

• [ ] Additional apps in crystal_toolkit.apps.examples demonstrating how to link multiple components together (e.g., two Crystal Toolkit components, like a structure visualization to an X-ray diffraction pattern, or e.g. a Crystal Toolkit component with a data table row or a plotly Graph object, like showing a crystal structure on selection of a row or data point)
  • This might reveal opportunities for design refinements or additional helper functions, but the primary purpose here is for user training / education
• [ ] Documentation pages of the above that embed the example app source code (see existing documentation for examples of this)
• [ ] Ensure that these example apps are run automatically in the tests
  • Currently, these tests simply check that the app starts, can optionally check for console output or for specific user interaction
  • Tests can initiate a screenshot via Percy, so that changes in app behavior are easily highlighted as an additional manual check
  • See existing tests for examples of both automating user interaction and taking of screenshots
  • This may be affected by #257

The user benefit will be to make it easier for new users to start using Crystal Toolkit -- ease-of-use is essential for the continued success of this code.

If you have any questions related to the above, please either ask them in this issue or contact privately.

---

Notice: Issues with the "new contributor" label are issues assigned to a specific individual who may either be a new contributor to this repository or who have only have had minimal prior experience. These issues refer to a specific pre-arranged set of action items, and are intended to welcome and onboard new developers. Please get in touch with mkhorton@lbl.gov if you would like to get involved and want a similar "new contributor" issue assigned.

[mkhorton]

This issue to be assigned to @janosh (pending invite).

[janosh]

@mkhorton Re existing tests, were you referring to?https://github.com/materialsproject/crystaltoolkit/blob/ae03e10290dfc9a5060ae2691044dfdffc0f6215/tests/test_usage.py#L1-L20

Looks like https://github.com/plotly/pytest-dash is deprecated and was merged into dash itself. I guess it makes sense to use a 1st party testing solution. But in case it's still up for discussion wanted to mention I've had good experiences on past projects with Playwright. It offers a Python API for cross-browser testing that supports chromium, firefox and webkit.