SciStudio API reference

Version: 0.3.5a0 (reference for this release).

The public API you may rely on, generated from the code's docstrings and scistudio.stability decorators. Only the public surface (each canonical root's __all__) appears; internal symbols are excluded. Import from the canonical root shown on each page, never a deeper module path.

The workflow file format has its own generated page: Workflow YAML file format (provisional) — the keys, rules, and JSON Schema of a workflow YAML file.

Stability

• stable — supported; no incompatible change within a major version without deprecation.
• provisional — usable, may change in a minor release.
• internal — excluded from this reference.

A symbol marked deprecated keeps its tier and keeps working until the release its notice names removes it; the notice names the replacement.

Canonical roots

• scistudio.core.types — 10 symbols
• scistudio.core.meta — 3 symbols
• scistudio.blocks.base — 13 symbols
• scistudio.blocks.process — 1 symbols
• scistudio.blocks.io — 12 symbols
• scistudio.blocks.app — 7 symbols
• scistudio.blocks.code — 60 symbols
• scistudio.tutorials — 16 symbols
• scistudio.api.app — 1 symbols
• scistudio.api.seam — 12 symbols
• scistudio.panels — 8 symbols

Panel contract

The panel SDK, components, and descriptor (panel API 1.0, provisional), generated from the panel sources.

• Panel SDK — window.scistudio: contexts, operations, read operations, errors, libraries
• Panel components — stylesheets, UI components, and data views
• Panel descriptor — panel.json keys and rules, and panel.sample.json