pfc_browse_python_api
Browse PFC Python SDK documentation by path to access function and object details for ITASCA PFC simulations. Use dot-separated paths to navigate modules, functions, and methods.
Instructions
Browse PFC Python SDK documentation by path (like glob + cat).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| api | No | PFC Python API path to browse (dot-separated, starting from itasca). Examples: - None or '': Root overview - all modules and objects - 'itasca': Core module functions (command, cycle, gravity, etc.) - 'itasca.ball': Ball module functions (create, find, list, etc.) - 'itasca.ball.create': Specific function documentation - 'itasca.ball.Ball': Ball object method groups - 'itasca.ball.Ball.pos': Specific method documentation - 'itasca.wall.facet': Nested submodule - 'itasca.wall.facet.Facet': Facet object in wall.facet module |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||