← Back to API reference

neuralfetch.download.Figshare

pydantic model neuralfetch.download.Figshare

Download all files from a Figshare article (figshare.com).

Fetches file metadata from the Figshare v2 public API and downloads each file into dset_dir/download/.

Parameters:

• study (str) – Figshare article ID (numeric string, e.g. "12345678"). Found in the article URL on figshare.com.

• skip_existing (bool) – If True (default), skip files that already exist locally and whose MD5 matches the Figshare metadata. Existing files with a mismatched (or unverifiable) checksum are re-downloaded.

• max_retries (int) – Number of times to retry a file whose download is truncated or whose checksum does not match (guards against expired presigned URLs that return an error page instead of the file).

Fields:

• max_retries (int)

• skip_existing (bool)

field skip_existing: bool = True

field max_retries: int = 3

requirements: tp.ClassVar[tuple[str, ...]] = ()

← Back to API reference