I have been working with some people interested in using the Calculation Engine, and received some helpful feedback on how we can improve the experience for a new user:
- Explicitly explain the Python API functions in
calculation_engine_api.pyin the documentation itself, if possible with examples. - Provide code snippets of the tutorial in the documentation, in addition to the full Notebook that can be downloaded. In this way, people can create their own notebooks or python scripts directly from the Quickstart.
- Provide basic examples of configurations for all available modules, and clarify that these can be run simply by replacing the config in the first tutorial example.