← Back to API reference

neuralfetch.download.Openneuro

pydantic model neuralfetch.download.Openneuro

Download datasets from OpenNeuro.

The include parameter follows the openneuro-py API: files and directories to download. Only these files and directories will be retrieved. Uses Unix path expansion (* for any number of wildcard characters and ? for one wildcard character; e.g. 'sub-1_task-*.fif'). As an example, if you would like to download only subject ‘1’ and run ‘01’ files, you can do so via 'sub-1/**/*run-01*'. The pattern ** will match any files and zero or more directories, subdirectories and symbolic links to directories.

The nworkers parameter controls how many files are downloaded in parallel (forwarded to openneuro.download as max_concurrent_downloads). The openneuro-py default is 5; raise it to speed up datasets with many files when network bandwidth allows.

Fields:

• excluded_patterns (list[str])

• include (list[str] | None)

• nworkers (int)

requirements: ClassVar[tuple[str, ...]] = ('openneuro-py>=2026.4.0',)

field excluded_patterns: list[str] = []

field include: list[str] | None = None

field nworkers: int = 5

← Back to API reference