AllenInstitute / AllenInstitute/AllenSDK

Download caching file to different name, then transfer once download complete

Open
#72 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement help wanted
Dominant language
Jupyter Notebook
Stars
398
Forks
163
PR merge metrics
No merged PRs in 30d

Description

Currently nwb files are downloaded into the cache directly. If a download is interrupted (for whatever reason), this partial file sits in the cache. At read time, the reader chokes because it tries to read this corrupt file, not knowing that it is incomplete.

Instead, can it download a file to 12345.nwb.download, and then afterwards do a quick rename to 12345.nwb. Then when the file is loaded, if is sees the 12345.nwb.download in the cache, it knows that the file is incomplete and tries to re-download the file.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the cache download and read paths described in the issue, then trace how interrupted NWB downloads are handled. Verify that downloads use a temporary .nwb.download name and are renamed only after completion, and that an incomplete marker triggers a re-download rather than being read.

Written by the indexing model from the issue text.

Assessment

Domain
data
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.