AllenNeuralDynamics / AllenNeuralDynamics/aind-nwb-utils

Document what metadata fields go into nwb and update tests

未關閉
#68 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
主要語言
Python
星號
1
分支
1
PR 合併指標
30 天內沒有已合併 PR

描述

When doing hotfix #63, realized there is no documentation in the repo on what exact aind metadata fields should go into the nwb. When tracing the commit history, seems like information from the procedures json was being used but then it was removed because it was causing problems.

I believe there is a sharepoint document or spreadsheet with this information somewhere, so we should add it as documentation here since this a core library used in many of the pipelines so it's documented and versioned. This will also help in updating tests and catching regressions (I thought I had fixed #63 earlier but because tests didn't scope it, it fell through), and will allow for more scoped tests to make sure the correct metadata is landing in the nwb (I think right now only the session description is being tested so we can add more).

貢獻指南

這個儲存庫沒有索引到貢獻指南

研究方向

The issue names no files or tests. Start by tracing the commit history around hotfix #63 and locating where procedures JSON metadata was used or removed. Use the available SharePoint document or spreadsheet to define the exact AIND metadata fields for NWB, then document them in the repository and add scoped tests that verify those fields, beyond the existing session-description coverage.

由索引模型根據 Issue 內容生成。

評估

技術堆疊
python
領域
data, documentation, testing
Issue 類型
文件
難度
4/5
預估耗時
3-5 天
活躍度
冷清
描述清晰度
基本清楚
新手友好度
45/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。