Autonima
Autonima is a usage-first toolkit for automated neuroimaging review workflows: search PubMed, screen studies with LLMs, retrieve full text, parse coordinates, and generate outputs for downstream meta-analysis.
The documentation here is focused on how to run the CLI and how to author a working config.yml. It is intentionally not a full Python API reference.
Who This Is For
- Researchers running systematic-review style neuroimaging pipelines from the command line
- Users preparing reproducible
config.ymlfiles for search, screening, retrieval, parsing, and annotation - Maintainers who need a stable reference for the CLI surface and the expected output layout
Workflow
- Install
autonimaand any optional extras you need. - Generate a starting config with
autonima create-sample-config. - Edit the config for your search query, screening criteria, and retrieval setup.
- Validate it with
autonima validate config.yaml. - Run the pipeline with
autonima run config.yaml. - Optionally run
autonima meta OUTPUT_FOLDERon the generated NiMADS outputs.
Start Here
- Installation
- Quickstart
- Configuration Guide
- CLI Usage Guide
- Outputs Guide
- Interpreting Outputs
- CLI Reference
Important Notes
runandvalidateuse positional arguments:autonima run CONFIG [OUTPUT_FOLDER].- If you omit
OUTPUT_FOLDER, the CLI defaults to a sibling directory derived from the config file stem. Example:projects/cue_reactivity/default.yamlbecomesprojects/cue_reactivity/default/. - The config file still needs a non-empty
output.directoryfield because configuration validation currently requires it.