Skip to content

Commit b6d93d5

Browse files
Diagram notation: update stored notebook outputs and prose to the shipped brand notation
- Stored dj.Diagram SVG outputs in 16 notebooks recolored from the interim #1534 hues to the shipped #1544 tier palette (deterministic hex mapping, light and dark values). - Stored make_mermaid text output updated to the palette the library now emits. - Legends and notation prose corrected (calcium-imaging, both ephys tutorials, relational-workflow-model, diagram spec): orange computed tier, rounded boxes, entity clusters for master-part, underline = new dimension; the spec's tier table now carries the exact palette. - rwm-pipeline.svg recolored; rwm-legend.svg already current.
1 parent e85db08 commit b6d93d5

19 files changed

Lines changed: 1427 additions & 1422 deletions

src/explanation/relational-workflow-model.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ the lineage of relational modeling follows.
1313
## A worked example
1414

1515
Diagrams in this documentation use the same notation as `dj.Diagram` in
16-
`datajoint-python`: **Manual** tables are green rectangles, **Lookup**
17-
tables are gray rectangles, **Imported** tables are blue ovals, and
18-
**Computed** tables are red ovals. A **Part** table is a plain rectangle
19-
grouped with its master inside a light box. Tier is conveyed by shape and
16+
`datajoint-python`: **Manual** tables are green rounded boxes, **Lookup**
17+
tables are gray rounded boxes, **Imported** tables are blue ellipses, and
18+
**Computed** tables are orange ellipses. A **Part** table is a small plain box
19+
grouped with its master inside a light box (the *entity cluster*). Tier is conveyed by shape and
2020
color, and **edge thickness** shows how a child relates to its parent — a
2121
thick line means the child **extends** the parent (one per parent); a thin
2222
line means the child is **contained within** the parent (many per parent).
@@ -41,7 +41,7 @@ dimension. The legend below the figure keys the full notation.
4141

4242
![Worked-example imaging pipeline diagram spanning two schemas: experiment (Mouse → Session → Scan) and analysis (AverageFrame → Segmentation → Fluorescence, with Lookup SegmentationParam feeding Segmentation, and the Part tables Roi on Segmentation and Trace on Fluorescence).](../images/rwm-pipeline.svg)
4343

44-
![Legend: table tiers — Manual (green rectangle), Lookup (gray rectangle), Imported (blue oval), Computed (red oval), Part (smaller plain rectangle); an underlined name is a new entity type (a new schema dimension, many rows per parent) while a plain name is composed from existing entities (one row per parent); edge thickness — thick means the child extends the parent, thin means the child is contained within the parent; a dashed rounded box is a schema module (labeled in the corner); a gray box encloses a master with its parts; edges have no arrowheads, so direction follows the layout.](../images/rwm-legend.svg)
44+
![Legend: table tiers — Manual (green rounded box), Lookup (gray rounded box), Imported (blue ellipse), Computed (orange ellipse), Part (smaller plain box); an underlined name is a new entity type (a new schema dimension, many rows per parent) while a plain name is composed from existing entities (one row per parent); edge thickness — thick means the child extends the parent, thin means the child is contained within the parent; a dashed rounded box is a schema module (labeled in the corner); a gray box encloses a master with its parts; edges have no arrowheads, so direction follows the layout.](../images/rwm-legend.svg)
4545

4646
The notation is specified in full in the [Diagram specification](../reference/specs/diagram.md). The concepts it depicts are explained in depth elsewhere: [entity integrity](entity-integrity.md) (keys, entity types, and schema dimensions), [master–part tables](../reference/specs/master-part.md) (the entity group and its all-or-nothing populate), the [computation model](computation-model.md) (how `make()` produces Imported and Computed tables), and [semantic matching](semantic-matching.md) (why a name means the same thing everywhere it appears).
4747

src/how-to/master-part.ipynb

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -102,30 +102,30 @@
102102
" [fill="#fffde7"] { fill: #3A3620; }\n",
103103
" [stroke="#c9bc5b"] { stroke: #C9BC5B; }\n",
104104
" [fill="#6b6420"] { fill: #EBE3A0; }\n",
105-
" [fill="#e7f3ec"] { fill: #16281F; }\n",
106-
" [stroke="#2f7d5b"] { stroke: #4FA97F; }\n",
107-
" [fill="#1b5138"] { fill: #BCE6CF; }\n",
108-
" [fill="#f2f4f7"] { fill: #242832; }\n",
109-
" [stroke="#a9b1bd"] { stroke: #8A93A1; }\n",
110-
" [fill="#495261"] { fill: #C9CFD9; }\n",
111-
" [fill="#fbeaec"] { fill: #331A1F; }\n",
112-
" [stroke="#b23a48"] { stroke: #D0687A; }\n",
113-
" [fill="#7c2430"] { fill: #F3C2CB; }\n",
114-
" [fill="#e2ecfa"] { fill: #152538; }\n",
115-
" [stroke="#2a5fa5"] { stroke: #5E92D6; }\n",
116-
" [fill="#123a6d"] { fill: #C3DAF6; }\n",
105+
" [fill="#E8F0E9"] { fill: #16281F; }\n",
106+
" [stroke="#3E7A52"] { stroke: #6BBF94; }\n",
107+
" [fill="#28513A"] { fill: #BCE6CF; }\n",
108+
" [fill="#F0F0F1"] { fill: #242832; }\n",
109+
" [stroke="#808285"] { stroke: #9DA0A4; }\n",
110+
" [fill="#5A5C5F"] { fill: #C9CFD9; }\n",
111+
" [fill="#FFEDE5"] { fill: #331B12; }\n",
112+
" [stroke="#FF5113"] { stroke: #FF7A47; }\n",
113+
" [fill="#B23200"] { fill: #FFC7AE; }\n",
114+
" [fill="#E0F4FC"] { fill: #0F2433; }\n",
115+
" [stroke="#00A0DF"] { stroke: #33B8E8; }\n",
116+
" [fill="#00537A"] { fill: #BEE7F9; }\n",
117117
" [fill="#ffffff"] { fill: #1E232C; }\n",
118-
" [stroke="#9aa6b8"] { stroke: #7B879B; }\n",
119-
" [fill="#46536b"] { fill: #C4CCDB; }\n",
118+
" [stroke="#B9BBBE"] { stroke: #8F959D; }\n",
119+
" [fill="#55585C"] { fill: #C8CED8; }\n",
120120
" [fill="#edeef0"] { fill: #242730; }\n",
121121
" [stroke="#808890"] { stroke: #8890A0; }\n",
122122
" [fill="#404040"] { fill: #C7CDD6; }\n",
123-
" [stroke="#3a424f"] { stroke: #AEB6C2; stroke-opacity: 0.753; }\n",
123+
" [stroke="#171C39"] { stroke: #AEB6C2; stroke-opacity: 0.753; }\n",
124124
" [stroke="#c77d3a"] { stroke: #D68C4A; stroke-opacity: 0.753; }\n",
125125
" [fill="#f3f5f8"] { fill: #2A313D; }\n",
126126
" [stroke="#f3f5f8"] { stroke: #2A313D; }\n",
127127
" [stroke="gray"] { stroke: #606875; }\n",
128-
" [fill="gray"] { fill: #8A93A1; }\n",
128+
" [fill="gray"] { fill: #9DA0A4; }\n",
129129
"}\n",
130130
"</style>\n",
131131
"<g id=\"graph0\" class=\"graph\" transform=\"scale(1 1) rotate(0) translate(4 152)\">\n",
@@ -147,8 +147,8 @@
147147
"------------------------------\r",
148148
"session_date         \r",
149149
"\">\n",
150-
"<path fill=\"#e7f3ec\" stroke=\"#2f7d5b\" d=\"M150.91,-58.28C150.91,-58.28 118.36,-58.28 118.36,-58.28 112.6,-58.28 106.84,-52.52 106.84,-46.76 106.84,-46.76 106.84,-35.24 106.84,-35.24 106.84,-29.48 112.6,-23.72 118.36,-23.72 118.36,-23.72 150.91,-23.72 150.91,-23.72 156.67,-23.72 162.43,-29.48 162.43,-35.24 162.43,-35.24 162.43,-46.76 162.43,-46.76 162.43,-52.52 156.67,-58.28 150.91,-58.28\"/>\n",
151-
"<text text-anchor=\"start\" x=\"114.76\" y=\"-38.1\" font-family=\"Helvetica,sans-Serif\" text-decoration=\"underline\" font-size=\"12.00\" fill=\"#1b5138\">Session</text>\n",
150+
"<path fill=\"#E8F0E9\" stroke=\"#3E7A52\" d=\"M150.91,-58.28C150.91,-58.28 118.36,-58.28 118.36,-58.28 112.6,-58.28 106.84,-52.52 106.84,-46.76 106.84,-46.76 106.84,-35.24 106.84,-35.24 106.84,-29.48 112.6,-23.72 118.36,-23.72 118.36,-23.72 150.91,-23.72 150.91,-23.72 156.67,-23.72 162.43,-29.48 162.43,-35.24 162.43,-35.24 162.43,-46.76 162.43,-46.76 162.43,-52.52 156.67,-58.28 150.91,-58.28\"/>\n",
151+
"<text text-anchor=\"start\" x=\"114.76\" y=\"-38.1\" font-family=\"Helvetica,sans-Serif\" text-decoration=\"underline\" font-size=\"12.00\" fill=\"#28513A\">Session</text>\n",
152152
"</a>\n",
153153
"</g>\n",
154154
"</g>\n",
@@ -162,15 +162,15 @@
162162
"response             \r",
163163
"reaction_time        \r",
164164
"\">\n",
165-
"<path fill=\"#ffffff\" stroke=\"#9aa6b8\" d=\"M145.55,-97.69C145.55,-97.69 123.72,-97.69 123.72,-97.69 120.15,-97.69 116.59,-94.13 116.59,-90.56 116.59,-90.56 116.59,-83.44 116.59,-83.44 116.59,-79.87 120.15,-76.31 123.72,-76.31 123.72,-76.31 145.55,-76.31 145.55,-76.31 149.12,-76.31 152.68,-79.87 152.68,-83.44 152.68,-83.44 152.68,-90.56 152.68,-90.56 152.68,-94.13 149.12,-97.69 145.55,-97.69\"/>\n",
166-
"<text text-anchor=\"start\" x=\"124.51\" y=\"-84.88\" font-family=\"Helvetica,sans-Serif\" text-decoration=\"underline\" font-size=\"10.00\" fill=\"#46536b\">Trial</text>\n",
165+
"<path fill=\"#ffffff\" stroke=\"#B9BBBE\" d=\"M145.55,-97.69C145.55,-97.69 123.72,-97.69 123.72,-97.69 120.15,-97.69 116.59,-94.13 116.59,-90.56 116.59,-90.56 116.59,-83.44 116.59,-83.44 116.59,-79.87 120.15,-76.31 123.72,-76.31 123.72,-76.31 145.55,-76.31 145.55,-76.31 149.12,-76.31 152.68,-79.87 152.68,-83.44 152.68,-83.44 152.68,-90.56 152.68,-90.56 152.68,-94.13 149.12,-97.69 145.55,-97.69\"/>\n",
166+
"<text text-anchor=\"start\" x=\"124.51\" y=\"-84.88\" font-family=\"Helvetica,sans-Serif\" text-decoration=\"underline\" font-size=\"10.00\" fill=\"#55585C\">Trial</text>\n",
167167
"</a>\n",
168168
"</g>\n",
169169
"</g>\n",
170170
"<!-- Session&#45;&gt;Session.Trial -->\n",
171171
"<g id=\"edge2\" class=\"edge\">\n",
172172
"<title>Session-&gt;Session.Trial</title>\n",
173-
"<path fill=\"none\" stroke=\"#3a424f\" stroke-width=\"0.75\" stroke-opacity=\"0.619608\" d=\"M134.63,-58.61C134.63,-64.38 134.63,-70.14 134.63,-75.91\"/>\n",
173+
"<path fill=\"none\" stroke=\"#171C39\" stroke-width=\"0.75\" stroke-opacity=\"0.619608\" d=\"M134.63,-58.61C134.63,-64.38 134.63,-70.14 134.63,-75.91\"/>\n",
174174
"</g>\n",
175175
"<!-- Subject -->\n",
176176
"<g id=\"node2\" class=\"node\">\n",
@@ -179,15 +179,15 @@
179179
"------------------------------\r",
180180
"species              \r",
181181
"\">\n",
182-
"<path fill=\"#e7f3ec\" stroke=\"#2f7d5b\" d=\"M59.32,-58.28C59.32,-58.28 27.52,-58.28 27.52,-58.28 21.76,-58.28 16,-52.52 16,-46.76 16,-46.76 16,-35.24 16,-35.24 16,-29.48 21.76,-23.72 27.52,-23.72 27.52,-23.72 59.32,-23.72 59.32,-23.72 65.08,-23.72 70.84,-29.48 70.84,-35.24 70.84,-35.24 70.84,-46.76 70.84,-46.76 70.84,-52.52 65.08,-58.28 59.32,-58.28\"/>\n",
183-
"<text text-anchor=\"start\" x=\"23.92\" y=\"-38.1\" font-family=\"Helvetica,sans-Serif\" text-decoration=\"underline\" font-size=\"12.00\" fill=\"#1b5138\">Subject</text>\n",
182+
"<path fill=\"#E8F0E9\" stroke=\"#3E7A52\" d=\"M59.32,-58.28C59.32,-58.28 27.52,-58.28 27.52,-58.28 21.76,-58.28 16,-52.52 16,-46.76 16,-46.76 16,-35.24 16,-35.24 16,-29.48 21.76,-23.72 27.52,-23.72 27.52,-23.72 59.32,-23.72 59.32,-23.72 65.08,-23.72 70.84,-29.48 70.84,-35.24 70.84,-35.24 70.84,-46.76 70.84,-46.76 70.84,-52.52 65.08,-58.28 59.32,-58.28\"/>\n",
183+
"<text text-anchor=\"start\" x=\"23.92\" y=\"-38.1\" font-family=\"Helvetica,sans-Serif\" text-decoration=\"underline\" font-size=\"12.00\" fill=\"#28513A\">Subject</text>\n",
184184
"</a>\n",
185185
"</g>\n",
186186
"</g>\n",
187187
"<!-- Subject&#45;&gt;Session -->\n",
188188
"<g id=\"edge1\" class=\"edge\">\n",
189189
"<title>Subject-&gt;Session</title>\n",
190-
"<path fill=\"none\" stroke=\"#3a424f\" stroke-width=\"0.75\" stroke-opacity=\"0.619608\" d=\"M71.19,-41C82.38,-41 95.36,-41 106.58,-41\"/>\n",
190+
"<path fill=\"none\" stroke=\"#171C39\" stroke-width=\"0.75\" stroke-opacity=\"0.619608\" d=\"M71.19,-41C82.38,-41 95.36,-41 106.58,-41\"/>\n",
191191
"</g>\n",
192192
"</g>\n",
193193
"</svg>"

0 commit comments

Comments
 (0)