Update the Documentation

seantrons commented 7 months ago

Documentation is used loosely here since we only have docstring comments, the demo.py file, and README.md.

Still, a bunch of new features have been added with relatively no discussion of their existing anywhere in the project. The demo.py file is doing more heavy lifting than it needs to as well. Perhaps it would be a good idea to split it up in the future. Maybe look at a documnetation generator too.

Recent additions I can think of off the top of my head:

rudimentary 3D graphics
near complete support for 2D plots (axes labels, log scaling, tick values, scatter plots, etc.)
performance logging. export environment var assignment: export VIEWER_PERF_LOG=1 to have data panes log to the console the time required to process every frame update.
animation support: animation is now achieved by wrapping data display pane instances with the animation class. doing such automatically provides user specified callbacks with access to the animation tick number, which can be used to alter frame generation behavior (e.g. render next frame of video sequence).

seantronsen commented 7 months ago

We also need to update the README.md file and any related media to cite the PyQtGraph team's efforts. The main goal of this repository is to simplify and ease the experience of rapidly building real-time data displays for algorithmic tuning and/or monitoring.

seantronsen commented 7 months ago

Added more content and updated descriptions to the README in this commit: https://github.com/seantronsen/qtviewer/commit/879b7861e0bb151711328b450490ee03dedab5a9

seantronsen commented 7 months ago

I think I'll eventually wire sphinx into this project and set up a github action to automatically compile the documentation for each new release, but that's well into the future. Marking this as a backburner item for now until at least this summer. Other items are more important.

seantrons commented 6 months ago

Since we have another issue for this (#31), I'm going to close this one as the code portion of the documentation has been updated several times since this issue opened.

If you're interested in the release of the sphinx docs mentioned here, follow #31.

seantronsen / pvt

Update the Documentation #3