PyFLASH Wiki

This wiki is the long-form PyFLASH reference. It explains objects, tables, parameters, plots, pipelines, statistics, outputs, workflows, and examples.

Start Here

Page	Purpose
Getting started	Short path through installation, first data object, first plot, UI launch, and outputs.
Installation	Install the package and optional UI extra.
First batch	Create or load a Batch from experiment folders.
First table-backed batch	Use a prepared pandas.DataFrame.
First plot	Make a basic plot.
First plot spec	Run plots from YAML, TOML, or JSON.
Launch the UI	Start the optional Streamlit interface.
Where results go	Find saved figures and run folders.

Main Reference

Page	Purpose
API reference	Public functions grouped by task.
Object model	Short overview of the main objects.
Object types	Detailed object pages.
Data structures	Tables, specs, ledgers, and manifests.
Parameters	Shared option vocabulary.
Plot types	Visual guide to plot families.
Statistics	Method and interpretation guides.
Outputs	Saved files and folders.
Workflows	Task-based guides.
Gallery	Compact examples.
Plot gallery	Rendered example of every plot, linked to its reference page.
Troubleshooting	Common problems and fixes.
Glossary	Short definitions.
Developer docs	Maintainer guidance.

Naming Convention

Preferred public names are data_cols, group, groupList, group_col, group_cols, subject_col, filter_by, and split_by. Legacy names such as filtered_columns, conditionList, condition_col, factor_cols, animal_col, specificity, and factor remain supported.