Metadata-Version: 2.4
Name: auto-eeg-analysis
Version: 0.3.3rc2
Summary: Reusable EEG analysis skills and study recipes for large language model agents
Author: Dengzhe Hou
License-Expression: MIT AND CC-BY-4.0
Project-URL: Homepage, https://dengzhe-hou.github.io/auto-eeg-analysis/
Project-URL: Repository, https://github.com/dengzhe-hou/auto-eeg-analysis
Project-URL: Documentation, https://github.com/dengzhe-hou/auto-eeg-analysis/blob/main/docs/GETTING_STARTED.md
Project-URL: Issues, https://github.com/dengzhe-hou/auto-eeg-analysis/issues
Keywords: EEG,MNE,agent,skills,neuroscience
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: analysis
Requires-Dist: numpy; extra == "analysis"
Requires-Dist: scipy; extra == "analysis"
Requires-Dist: matplotlib; extra == "analysis"
Requires-Dist: pandas; extra == "analysis"
Requires-Dist: h5py; extra == "analysis"
Requires-Dist: mne[hdf5]>=1.7; extra == "analysis"
Requires-Dist: mne-bids>=0.14; extra == "analysis"
Requires-Dist: mne-icalabel>=0.6; extra == "analysis"
Requires-Dist: onnxruntime>=1.16; extra == "analysis"
Requires-Dist: autoreject>=0.4; extra == "analysis"
Requires-Dist: pycrostates>=0.5; extra == "analysis"
Requires-Dist: mne-connectivity>=0.7; extra == "analysis"
Requires-Dist: pyprep>=0.4; extra == "analysis"
Requires-Dist: mffpy; extra == "analysis"
Requires-Dist: eeglabio; extra == "analysis"
Dynamic: license-file

# Auto EEG Analysis (AEA)

AEA provides reusable EEG analysis skills and study recipes for large language
model coding agents. MNE-Python is the primary computation backend. Selected
EEGLAB and FieldTrip routes are described in the bundled documentation.

This package installs the resource library and a project initialization command.
It includes 22 skills, 10 study recipes, analysis helpers, templates and setup
documentation. It does not install or configure a model client or an account.

## Install and create a project

Use Python 3.10 or newer in an environment of your choice.

```sh
python -m pip install auto-eeg-analysis==0.3.3rc2
aea-eeg init ./my-eeg-study --agent codex
cd my-eeg-study
```

Use `--agent claude` for Claude Code or `--agent both` for both clients.
The command copies the library into a new or empty directory and creates
project-local skill links using AEA's existing installer. Existing nonempty
directories are refused. It does not change global client configuration.
`python -m auto_eeg_analysis` accepts the same arguments as `aea-eeg`.

The default installation has no scientific runtime dependencies. Reuse your
existing MNE environment, use the included `environment.yml` to create one,
or install the analysis dependencies from the existing environment specification.

```sh
python -m pip install 'auto-eeg-analysis[analysis]==0.3.3rc2'
```

Read `AGENT_GUIDE.md`, select procedures through `RESOURCE_INDEX.md`, and approve
the study-specific analysis plan. Start the separately installed coding client
from the initialized project directory. `aea-eeg path` shows the installed
resource directory.

## Version and evidence

This packaging candidate uses published AEA source commit
`cdc0c30105cc4547aed8e5ece41739a8462cb47a`. The package version identifies this
distribution. Retained scientific validation records and plugin versions keep
their original identifiers. Packaging checks do not extend the numerical
validation coverage in `docs/CERTIFICATION_LEVELS.md`.

The package contains no participant datasets, model credentials or archived model
sessions. The Git repository remains the development source and the place for
contributions and support.

## License and citation

Code and skills use the repository's MIT license. Study recipes use CC BY 4.0
as stated in `recipes/README.md`. Preserve the recipe citations and original
license notices. `CITATION.cff` retains the source repository's citation metadata.

[Project](https://github.com/dengzhe-hou/auto-eeg-analysis) ·
[Setup guide](https://github.com/dengzhe-hou/auto-eeg-analysis/blob/main/docs/GETTING_STARTED.md) ·
[Validation coverage](https://github.com/dengzhe-hou/auto-eeg-analysis/blob/main/docs/CERTIFICATION_LEVELS.md)
