You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Here are some of my initial thoughts about the tutorials in general:
a markdown file summarizing each of the tutorials and/or suggesting an order in which a user should work through them would be helpful. I see that there is a bit more info in https://pvops.readthedocs.io/en/latest/pages/examples.html. If the readthedocs example page is the best place to start, that should be linked in the README.md when referencing the examples directory. E.g., "Refer to the examples directory, following the guide at https://pvops.readthedocs.io/en/latest/pages/examples.html, for a full run-through of the available functionality."
In general, more text in the tutorials to give context would be helpful. Perhaps this could be done by making setting up a fictional solar plant that all of the tutorials and example data would be based on. Give it a fake name, say where it is located, how big it is, what assets it has, etc. Talk about how it has a maintenance team that keeps written maintenance logs (show an example subset of a log file), and how there is there is a weather station and power meter with measurements logged to a data historian, etc. Then describe the tasks (real-world business needs/questions) that a performance engineer (the user going through the tutorials) will be trying to complete. In the process, reference all of the example data files that will be used in the tutorials.
The text was updated successfully, but these errors were encountered:
Here are some of my initial thoughts about the tutorials in general:
examples
directory. E.g., "Refer to theexamples
directory, following the guide at https://pvops.readthedocs.io/en/latest/pages/examples.html, for a full run-through of the available functionality."The text was updated successfully, but these errors were encountered: