Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
.claude/
~$*
build/
figures/fig5_bbqs_stack/fig5_bbqs_stack_tuned/
12 changes: 10 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Build generated figures and check the TODO list against the draft.
#
# make figures regenerate all generated figures into figures/ (paper figures and alternates)
# make fig5 Fig. 5 SVG (links, layers) from its .pptx, and its walkthrough with svgtune if installed
# make alternates regenerate only the alternate figures (figures/alternates/, not in the paper)
# make pdf render the full draft (draft/*.md) as build/paper.tex and build/paper.pdf for review
# make check check that every [TODO-Cn] marker in draft/ has an entry in plan/TODO.md and vice versa
Expand All @@ -11,9 +12,9 @@ ECOKG := $(KG)/.venv/bin/ecokg
UVRUN := uv run -q --no-project --with openpyxl --with matplotlib python
PDF_DATE := $(shell date +%Y-%m-%d), commit $(shell git rev-parse --short HEAD 2>/dev/null || echo unknown)

.PHONY: figures fig3 fig4 alternates alt-kg-lenient pdf check kg-env
.PHONY: figures fig3 fig4 fig5 alternates alt-kg-lenient pdf check kg-env

figures: fig3 fig4 alternates
figures: fig3 fig4 fig5 alternates

alternates: alt-kg-lenient

Expand All @@ -32,6 +33,13 @@ alt-kg-lenient: $(ECOKG)
fig4:
$(UVRUN) analysis/bbqs_inventory.py

FIG5 := figures/fig5_bbqs_stack

fig5:
python3 tools/pptx2svg.py $(FIG5)/fig5_bbqs_stack.yaml
@if command -v svgtune >/dev/null; then cd $(FIG5) && svgtune fig5_bbqs_stack.svgtune; \
else echo "svgtune (https://github.com/yarikoptic/svgtune) not found: walkthrough not generated"; fi

pdf:
mkdir -p build
pandoc --defaults tools/pdf/defaults.yaml -M date="Review draft, $(PDF_DATE)" \
Expand Down
8 changes: 4 additions & 4 deletions figures/fig5_bbqs_stack/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
| | |
|---|---|
| Cited in | Section 6 |
| Status | design draft (`fig5_bbqs_stack_design.pptx`, preview `fig5_bbqs_stack_design.png`); edit the .pptx directly; final artwork by designer |
| Status | design draft (`fig5_bbqs_stack_design.pptx`, preview `fig5_bbqs_stack_design.png`); edit the .pptx directly; final artwork by designer. Generated from it: `fig5_bbqs_stack.svg`, with a link on every element, and a walkthrough (`fig5_bbqs_stack.svgtune`) |
| Concept | Layers 1, 2, 3, and 5 stacked in Table 1 order; ontologies & terminologies (4) and schema languages (6) as side panels next to rows 2–3, which they both serve. Columns NWB, BIDS, Psych-DS. Each cell shows what is recommended today (solid), what is in progress (dashed; labeled by what it adds), and what needs a standard (grey, dashed). |
| Rows | 1 formats with what they hold (HDF5 · Zarr for NWB files; MP4 · AVI · MOV video linked from NWB; NIfTI · OME-Zarr; EDF · BrainVision; JSON · TSV; WAV · MP4 · PNG via BIDS PR #2367; CSV · JSON) · 2 NWB core, with extensions and enhancement proposals labeled by purpose (pose estimation = ndx-pose, structured behavior, microscopy = NWBEP004, HED annotation = ndx-hed, fiber photometry, wearable devices, multi-subject = ndx-multisubjects, ethogram); a dashed green line joins Multi-subject to the planned multi-subject BEP (planned companion proposals) · 3 DANDI layout; BIDS with BEP032, BEP047, BEP020/BEP042, multi-subject BEP; Psych-DS · 5 EMBER. Panel 4: HED; Neuro Termsets (in progress) with arrows to the terminologies it draws on; NCBI Taxonomy, UBERON, Allen atlases, RRID, ORCID · ROR, Cell Ontology, one box each; behavior labels (gap). Panel 6: HDMF → NWB, BIDS schema → BIDS, LinkML → Psych-DS and Neuro Termsets (Dandiset and NWB schema translations to LinkML planned), JSON Schema (Pydantic) → DANDI layout and EMBER archive metadata (Pydantic models in dandi/dandi-schema; JSON Schema and JSON-LD context published in dandi/schema). |
| Paths | Each data type appears once; thin lines with junction dots join it to every standard that can hold it (Table 3). Path colours by standard: NWB orange (data → NWB → EMBER), BIDS green, Psych-DS slate; data-format boxes, the DANDI layout, and Psych-DS are outlined in the colour of the path they sit on; a green arrow from NWB to the BIDS path shows that BIDS can contain NWB files (BEP032). Data without a standard (Table 3 gap row) have no path. |
| Rows | 1 formats with what they hold (HDF5 · Zarr for NWB files; MP4 · AVI · MOV video linked from NWB; NIfTI · OME-Zarr; EDF · BrainVision (EEG, iEEG, EMG; BIDS accepts only EDF and BDF for EMG); JSON · TSV; WAV · MP4 · PNG via BIDS PR #2367; CSV · JSON) · 2 NWB core, with extensions and enhancement proposals labeled by purpose (pose estimation = ndx-pose, structured behavior, microscopy = NWBEP004, HED annotation = ndx-hed, fiber photometry, wearable devices, multi-subject = ndx-multisubjects, ethogram); a dashed green line joins Multi-subject to the planned multi-subject BEP (planned companion proposals) · 3 DANDI layout; BIDS (eye tracking and EMG are in BIDS since v1.11) with BEP032, BEP047, BEP044 (stimuli), multi-subject BEP; Psych-DS · 5 EMBER. Panel 4: HED; Neuro Termsets (in progress) with arrows to the terminologies it draws on; NCBI Taxonomy, UBERON, Allen atlases, RRID, ORCID · ROR, Cell Ontology, one box each; behavior labels (gap). Panel 6: HDMF → NWB, BIDS schema → BIDS, LinkML → Psych-DS and Neuro Termsets (Dandiset and NWB schema translations to LinkML planned), JSON Schema (Pydantic) → DANDI layout and EMBER archive metadata (Pydantic models in dandi/dandi-schema; JSON Schema and JSON-LD context published in dandi/schema). |
| Paths | Each data type appears once; thin lines with junction dots join it to every standard that can hold it (Table 3). Path colours by standard: NWB orange (data → NWB → EMBER), BIDS green, Psych-DS slate; data-format boxes, the DANDI layout, and Psych-DS are outlined in the colour of the path they sit on; a green arrow from NWB to the BIDS path shows that BIDS allows NWB files for iEEG, and BEP032 would add microelectrode electrophysiology. EMG is a data type of its own, on the BIDS path only (Table 3). Data without a standard (Table 3 gap row) have no path. |
| Draft choices | Styled like Fig. 2: Arial; layer rows with a light tint, coloured outline, top band, and numbered badge in the Fig. 1 colours (palette in `../fig1_ecosystem_map/README.md`); technologies as white chips outlined in their layer colour; raw data in grey (as Level 0 in Fig. 2); in-progress items as dashed chips and gaps as grey dashed boxes; paths coloured by standard; legend at the top. Each box carries its own text (one shape per item), so boxes can be moved and edited as single objects. Canvas 13.33 × 8.6 in (same width as Figs. 1 and 2, taller for the detail). Stack geometry (D8): four stacked rows (formats, file organization, dataset organization, archives) with ontologies and schema languages as side panels next to the two organization rows, which they both serve. The speaker notes describe the rows and paths. |
| Source | Spec and legend in `draft/12_figures_tables.md`; content from Section 6, Table 3, the BBQS standards guideline, and the Standards4BBQS slides of the BBQS Forum (Oct 2026). Proposal status is as of Oct 2026 and must be rechecked before submission. |
| Build | Not generated; the design draft .pptx is the editable source. The PNG preview is exported at 300 dpi; re-export it after editing the .pptx. Place the final artwork here. |
| Build | The design draft .pptx is the editable source. `make fig5` writes `fig5_bbqs_stack.svg` from it with `tools/pptx2svg.py`, which adds the links and the build steps (Inkscape layers) listed in `fig5_bbqs_stack.yaml`, and, if [svgtune](https://github.com/yarikoptic/svgtune) is installed, the walkthrough `fig5_bbqs_stack_tuned/<step>.svg` (not committed): stack, data types, the NWB path (formats, files, DANDI layout, EMBER), the BIDS path (with NWB dimmed), companion proposals, the Psych-DS path, ontologies, gaps. Rerun it after editing the .pptx, and add links for new shapes to the .yaml. The PNG preview is rendered from the SVG at 300 dpi. Place the final artwork here. |
| Legend | `draft/12_figures_tables.md` (single source for all legends) |
| Open tasks | `plan/TODO.md`, section "3. Figures" (F3, F10) |
Loading
Loading