neuralfetch.download.BaseDownload¶

class neuralfetch.download.BaseDownload(*, study: str, dset_dir: str | Path, folder: str = 'download')[source][source]¶

Abstract base class for all neuralfetch download backends.

Subclasses must implement _download(). The public download() method wraps _download with idempotency checks via a success file: once a dataset has been downloaded successfully, subsequent calls are no-ops unless overwrite=True is passed.

Parameters:

study (str) – Dataset identifier (e.g. a Dandiset ID, Zenodo record, or study name).
dset_dir (PathLike) – Root directory for the study. The parent must already exist; this directory and the folder/ sub-directory are created automatically.
folder (str) – Name of the sub-directory inside dset_dir where raw files land. Defaults to "download".