toksearch-quickstart
Quick-reference for writing TokSearch + DIII-D pipeline scripts — imports, invocation, API gotchas, and signal types
用 Codex 或 Claude 帮你安装 复制这段 Prompt,粘贴到 Codex、Claude 或其他助手里,让它检查 Skill 页面并帮你完成安装。
菜单
Quick-reference for writing TokSearch + DIII-D pipeline scripts — imports, invocation, API gotchas, and signal types
用 Codex 或 Claude 帮你安装 复制这段 Prompt,粘贴到 Codex、Claude 或其他助手里,让它检查 Skill 页面并帮你完成安装。
Read this FIRST when unsure which Signal class or data path a DIII-D quantity needs. Maps physics quantities (Ip, Wmhd, beta_N, q95, NBI power, density, Te, boundary, ...) to the correct Signal class and path, how to discover IMAS paths, and which skill to use for time-alignment/correlation. Avoids the common mistake of using PtDataSignal for a quantity that lives in MDSplus or IMAS.
fdp CLI for FDP/Pelican data access — fdp run, fdp env, fdp ls, authentication, and available DIII-D data
ImasSignal for DIII-D IMAS IDS data — leaf/prefix paths, ragged arrays, channel splitting, dimension control, and shared ImasComposer
PtDataSignal and RDataSignal for DIII-D PTDATA diagnostics — constructor args, calibration, times in milliseconds, Pipeline usage, and xarray conversion
| 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/"} |
The canonical documentation now lives in the package docstrings.
help(toksearch) or python -c "help(toksearch)"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.