Guide through This Documentation#
Below is a guide through this documentation, ordered from beginner to advanced:
If you are new to PyTTOP and would like to determine whether it suits your needs, check Why PyTTOP.
To install PyTTOP, follow the instructions here.
To quickly explore a typical usage flow of PyTTOP, start with the quickstart example tutorial.
For the detailed introduction, refer to the documentation under each topic.
While this documentation covers many aspects of PyTTOP, it is impossible to include all the features. For information on each method or function, go to the API reference and search for the method, or use Python’s
help()function to view the documentation directly.
Tip
Multiple versions of this documentation are available, as listed below. You can switch versions using the selector at the lower-right corner of the page, or by directly modifying the URL—for example, changing pyttop.readthedocs.io/en/stable/* to pyttop.readthedocs.io/en/latest/*.
latest: the newest version of the documentation, usually reflecting features in the current development version. Some features described here may not exist in your installed version; if needed, follow the installation instructions here to update to the latest development version.
stable: corresponds to the most recent version released on PyPI.