| name | toksearch-quickstart |
| description | Quick-reference for writing TokSearch + DIII-D pipeline scripts — imports, invocation, API gotchas, and signal types |
| user-invocable | false |
| license | Apache-2.0 |
| compatibility | Claude Code |
| metadata | {"author":"GA-FDP","version":"2.0","url":"https://ga-fdp.github.io/toksearch/"} |
TokSearch Quickstart
The canonical documentation now lives in the package docstrings.
- Core Pipeline API:
help(toksearch) or python -c "help(toksearch)"
- DIII-D signals & fdp CLI:
help(toksearch_d3d) or python -c "help(toksearch_d3d)"
Together they cover: imports, invocation, Pipeline lifecycle, signal types, backends, DataFrame conversion, and all critical API gotchas.