NeuroMorphoDownloadRecord

NeuroMorphoDownloadRecord#

class braincell.io.NeuroMorphoDownloadRecord(folder, metadata_path, download_items, measurement, download_mode, dry_run=False)[source]#

Result of a multi-file download for a neuron.

Returned by NeuroMorphoClient.download() and the fetch_neuromorpho() Tier-1 helper.

Parameters:
  • folder (Path) – Per-neuron cache folder.

  • metadata_path (Path) – Path of the metadata.json written alongside the downloads.

  • download_items (tuple[NeuroMorphoDownloadItem, ...]) – Per-file download outcomes.

  • measurement (NeuroMorphoMeasurement | None) – Typed morphometry record fetched alongside the files. None when the call was a dry run.

  • download_mode (Literal['standard', 'original', 'both']) – The download mode used; one of "standard", "original", "both".

  • dry_run (bool) – True if the record was produced without touching the network or filesystem.