itasca_browse_python_api
Browse Itasca Python SDK documentation by dot-separated API path for a chosen engine, from root modules to specific functions and methods. Use it to quickly locate SDK references and usage details.
Instructions
Browse Itasca Python SDK documentation by path (like glob + cat).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| api | No | Itasca 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 | |
| software | Yes | ITASCA engine to query: 'pfc', 'flac', '3dec', 'mpoint', or 'massflow'. Required — there is no default engine. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||