danielrosehill Claude Opus 5 (1M context) commited on
Commit
dd07087
·
1 Parent(s): 9258bfa

Add a data dictionary as the single source, and a v1.0 datasheet

Browse files

dictionary.py now holds one definition per column for both tables — name, dtype,
unit, description — and build.py renders it four ways: data-dictionary.csv,
docs/data-dictionary.md, the card's Fields table, and the Hub's dtype frontmatter.
None of those is hand-written any more. The descriptions were previously prose in
the README and the dtypes a separate dict in build.py, so the two could disagree
about the same column and nothing would notice.

check() fails the build when a builder emits a column the dictionary does not
document, or documents one it does not emit, order included. Verified by removing
a column from the dictionary and confirming build.py exits 1 rather than writing a
dataset whose documentation is wrong.

datasheet/datasheet.typ is a datasheet for the dataset rather than a reference to
the sizes: scope in and out, composition of both tables, how each family's numbers
were derived and why ALCs have no internal dimensions, known limitations, capture
provenance, and the full dictionary. It reads data-dictionary.csv, containers.csv
and listings.csv at compile time, so the counts, the vendor table and the schema
cannot drift from the data. The only value passed in is the version, via
version.json.

The dictionary carries a schema version, 1.0, stamped into the datasheet filename
and footer. Minor bump for a column added or a description materially changed,
major for a column removed or redefined under an unchanged name; row additions and
capacity revisions do not move it.

This leaves two PDF toolchains in the repo on purpose, now noted in the card: the
dimensional reference stays on reportlab, which is laying out long generated tables
of sizes, and the datasheet is Typst, being a document that happens to read data.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

README.md CHANGED
@@ -186,7 +186,14 @@ typical = load_dataset("danielrosehill/storage-container-dimensions", split="tr
186
  listings = load_dataset("danielrosehill/storage-container-dimensions", "listings", split="train")
187
  ```
188
 
189
- Prefer it on paper? The same data is rendered as an 8-page printable reference —
 
 
 
 
 
 
 
190
  every size, its typical internal dimensions, its usable capacity and the vendor
191
  spread, divided by family:
192
  **[`reference/storage-container-reference.pdf`](reference/storage-container-reference.pdf)**.
@@ -291,35 +298,44 @@ a large order.**
291
 
292
  ## Fields
293
 
294
- | Field | Notes |
295
- |---|---|
296
- | `id` | Stable slug, e.g. `euro-600x400x230`, `alc-600x400x310`, `vda-rklt-6429` |
297
- | `type` | `euro_stacking_container` · `attached_lid_container` · `vda_klt_container` |
298
- | `type_label` | Human-readable form of `type` |
299
- | `common_names` | Semicolon-separated search terms, ordered most standard to most colloquial, including regional ones (`Eurobehälter`, `bac gerbable`) and genericised vendor names (`Hudson box`). Search terms only — never discriminate families on them, see [`guidance/naming.md`](guidance/naming.md) |
300
- | `external_length_cm` / `external_width_cm` / `external_height_cm` | External, in cm |
301
- | `external_length_in` / `external_width_in` / `external_height_in` | The same, in inches. Always the derived side on this table — these nominal sizes are fixed in millimetres by the standards |
302
- | `external_volume_l` | L × W × H. **Not** what the box holds |
303
- | `external_volume_gal` | The same, in US liquid gallons |
304
- | `internal_length_cm` / `internal_width_cm` / `internal_height_cm` | Typical internal, in cm. Populated for every Euro row and for the two KLT sizes a vendor publishes; empty for ALCs — see below |
305
- | `internal_length_in` / `internal_width_in` / `internal_height_in` | The same, in inches |
306
- | `internal_dims_basis` | Where those internal figures came from: `vendor_average_rule`, `vendor_published`, `not_published`, `not_published_tapered_walls` |
307
- | `internal_dims_vendors` | How many **vendors** publish internal dimensions for this footprint. Vendors, not listings — one mould in five colours is one opinion |
308
- | `typical_capacity_l` | **The usable number.** Always populated |
309
- | `typical_capacity_gal` | The same, in US liquid gallons |
310
- | `vendor_capacity_low_l` / `vendor_capacity_high_l` | Capacity implied by the least and the most generous vendor's own published internal dimensions for this footprint. Empty where no vendor publishes any. See [`guidance/internal-dimensions.md`](guidance/internal-dimensions.md) |
311
- | `usable_ratio` | `typical_capacity_l / external_volume_l` |
312
- | `capacity_basis` | How the capacity was arrived at see below |
313
- | `lidded` | True where a lid is integral to the product (ALCs) |
314
- | `lid_available_separately` | True where a lid exists but is a separate purchase |
315
- | `nestable_when_empty` | True for ALCs; straight-walled boxes stack but do not nest |
316
- | `typical_nesting_ratio` | Fraction of its own height a nested empty box saves. 0.75 for ALCs, **0 for everything else** that is a fact about a straight-walled box, not missing data |
317
- | `standard_conformant` | Whether the footprint conforms to a recognised module |
318
- | `standard` | Which one, stated precisely |
319
- | `vda_4500_height` | Whether the external height is on the VDA KLT grid |
320
- | `eur1_pallet_per_layer` | Boxes per layer on a 1200 × 800 Euro pallet, no overhang. The one column that reaches past the box itself — see [Scope](#scope) |
321
- | `listings_observed` | How many rows in the `listings` table back this size 0 means the row is a plausible interpolation, not something seen for sale |
322
- | `notes` | Per-row caveats. Read these |
 
 
 
 
 
 
 
 
 
323
 
324
  ### Height coverage
325
 
@@ -510,6 +526,15 @@ Longer notes that did not fit the card:
510
  systems, what `native_unit` is for, the US near-miss footprints, and precisely what
511
  is standardised and what is only convention.
512
 
 
 
 
 
 
 
 
 
 
513
  ## Regenerating
514
 
515
  `containers.csv`, `containers.jsonl` **and this card's YAML frontmatter** are all
@@ -517,7 +542,8 @@ produced by `build.py`, which holds the internal-dimension rules in one place so
517
  rule change cannot leave them disagreeing. Edit the rules there, not the CSV.
518
 
519
  ```bash
520
- python3 build.py # listings.csv, containers.*, this frontmatter
 
521
  python3 scripts/build_reference_pdf.py # reference/storage-container-reference.pdf
522
  python3 scripts/capture_salesbridges.py # only if you want to re-fetch raw/
523
  ```
@@ -527,6 +553,16 @@ and listings behind them. Only `scripts/capture_salesbridges.py` touches the net
527
  The PDF needs reportlab (`pip install -r scripts/requirements.txt`); rerun it after
528
  `build.py`, since it renders the CSVs rather than recomputing anything.
529
 
 
 
 
 
 
 
 
 
 
 
530
  `container_stats.py` holds the per-vendor internal-dimension statistics that both
531
  `build.py` and the PDF report as fact, so the two cannot disagree about what a
532
  vendor publishes.
 
186
  listings = load_dataset("danielrosehill/storage-container-dimensions", "listings", split="train")
187
  ```
188
 
189
+ Two documents come with it, both generated from the CSVs so neither can drift:
190
+
191
+ | | |
192
+ |---|---|
193
+ | **[`datasheet/storage-container-dimensions-datasheet-v1.0.pdf`](datasheet/storage-container-dimensions-datasheet-v1.0.pdf)** | The **datasheet**, v1.0 — scope, composition, how every number was derived, known limitations, provenance, and the full data dictionary. Read this before using the data in anything that matters. |
194
+ | **[`docs/data-dictionary.md`](docs/data-dictionary.md)** · **[`data-dictionary.csv`](data-dictionary.csv)** | Every column in both tables with its type, unit and meaning — as a document and machine-readable. |
195
+
196
+ Prefer the sizes themselves on paper? The same data is rendered as an 8-page printable reference —
197
  every size, its typical internal dimensions, its usable capacity and the vendor
198
  spread, divided by family:
199
  **[`reference/storage-container-reference.pdf`](reference/storage-container-reference.pdf)**.
 
298
 
299
  ## Fields
300
 
301
+ | Field | Type | Notes |
302
+ |---|---|---|
303
+ | `id` | string | Stable slug, e.g. `euro-600x400x230`, `alc-600x400x310`, `vda-rklt-6429` |
304
+ | `type` | string | `euro_stacking_container` · `attached_lid_container` · `vda_klt_container` |
305
+ | `type_label` | string | Human-readable form of `type` |
306
+ | `common_names` | string | Semicolon-separated search terms, ordered most standard to most colloquial, including regional ones (`Eurobehälter`, `bac gerbable`) and genericised vendor names (`Hudson box`). Search terms only — never discriminate families on them, see `guidance/naming.md` |
307
+ | `external_length_cm` | float64 (cm) | External length |
308
+ | `external_width_cm` | float64 (cm) | External width |
309
+ | `external_height_cm` | float64 (cm) | External height |
310
+ | `external_length_in` | float64 (in) | External length in inches. Always the derived side on this table — these nominal sizes are fixed in millimetres by the standards |
311
+ | `external_width_in` | float64 (in) | External width in inches, derived |
312
+ | `external_height_in` | float64 (in) | External height in inches, derived |
313
+ | `external_volume_l` | float64 (L) | L × W × H. **Not** what the box holds |
314
+ | `external_volume_gal` | float64 (US gal) | External volume in US liquid gallons |
315
+ | `internal_length_cm` | float64 (cm) | Typical internal length. Populated for every Euro row and for the two KLT sizes a vendor publishes; empty for ALCs, whose taper makes a single internal dimension meaningless |
316
+ | `internal_width_cm` | float64 (cm) | Typical internal width, same basis |
317
+ | `internal_height_cm` | float64 (cm) | Typical internal height, same basis |
318
+ | `internal_length_in` | float64 (in) | Typical internal length in inches, derived |
319
+ | `internal_width_in` | float64 (in) | Typical internal width in inches, derived |
320
+ | `internal_height_in` | float64 (in) | Typical internal height in inches, derived |
321
+ | `internal_dims_basis` | string | Where those internal figures came from: `vendor_average_rule`, `vendor_published`, `not_published`, `not_published_tapered_walls` |
322
+ | `internal_dims_vendors` | int64 | How many **vendors** publish internal dimensions for this footprint. Vendors, not listings — one mould in five colours is one opinion |
323
+ | `typical_capacity_l` | float64 (L) | **The usable number.** Always populated |
324
+ | `typical_capacity_gal` | float64 (US gal) | Usable capacity in US liquid gallons |
325
+ | `vendor_capacity_low_l` | float64 (L) | Capacity implied by the least generous vendor's own published internal dimensions for this footprint. Empty where no vendor publishes any |
326
+ | `vendor_capacity_high_l` | float64 (L) | As above, most generous vendor. See `guidance/internal-dimensions.md` |
327
+ | `usable_ratio` | float64 | `typical_capacity_l / external_volume_l` |
328
+ | `capacity_basis` | string | How the capacity was arrived at: `derived_from_internal_dims`, `vendor_nominal`, `published`, `derived_from_klt_ratio` |
329
+ | `lidded` | bool | True where a lid is integral to the product (ALCs) |
330
+ | `lid_available_separately` | bool | True where a lid exists but is a separate purchase |
331
+ | `nestable_when_empty` | bool | True for ALCs; straight-walled boxes stack but do not nest |
332
+ | `typical_nesting_ratio` | float64 | Fraction of its own height a nested empty box saves. 0.75 for ALCs, **0 for everything else** — that is a fact about a straight-walled box, not missing data |
333
+ | `standard_conformant` | bool | Whether the footprint conforms to a recognised module |
334
+ | `standard` | string | Which one, stated precisely |
335
+ | `vda_4500_height` | bool | Whether the external height is on the VDA KLT grid (147.5 / 213 / 280 mm) |
336
+ | `eur1_pallet_per_layer` | int64 | Boxes per layer on a 1200 × 800 Euro pallet, no overhang. The one column that reaches past the box itself — see Scope |
337
+ | `listings_observed` | int64 | How many rows in the `listings` table back this size — 0 means the row is a plausible interpolation, not something seen for sale |
338
+ | `notes` | string | Per-row caveats. Read these |
339
 
340
  ### Height coverage
341
 
 
526
  systems, what `native_unit` is for, the US near-miss footprints, and precisely what
527
  is standardised and what is only convention.
528
 
529
+ ## Versioning
530
+
531
+ The data dictionary carries a version — currently **1.0** — set in `dictionary.py` and
532
+ stamped into the datasheet filename and its footer. It describes the *schema*: bump
533
+ the minor version when a column is added or a description changes materially, the
534
+ major when a column is removed or its meaning changes under an unchanged name. Row
535
+ additions and capacity revisions do not move it; those are visible in the git history
536
+ and in `captured_date`.
537
+
538
  ## Regenerating
539
 
540
  `containers.csv`, `containers.jsonl` **and this card's YAML frontmatter** are all
 
542
  rule change cannot leave them disagreeing. Edit the rules there, not the CSV.
543
 
544
  ```bash
545
+ python3 build.py # listings.csv, containers.*, dictionary, frontmatter
546
+ ./datasheet/build.sh # datasheet/...-datasheet-v1.0.pdf (needs typst)
547
  python3 scripts/build_reference_pdf.py # reference/storage-container-reference.pdf
548
  python3 scripts/capture_salesbridges.py # only if you want to re-fetch raw/
549
  ```
 
553
  The PDF needs reportlab (`pip install -r scripts/requirements.txt`); rerun it after
554
  `build.py`, since it renders the CSVs rather than recomputing anything.
555
 
556
+ The data dictionary lives in `dictionary.py` and is rendered four ways —
557
+ `data-dictionary.csv`, `docs/data-dictionary.md`, this card's Fields table and the
558
+ frontmatter dtypes. `build.py` fails if a builder emits a column the dictionary does
559
+ not document, or documents one it does not emit, so the schema and its documentation
560
+ cannot drift apart. Add a column in both places or the build stops.
561
+
562
+ Two PDF toolchains, deliberately: the reference is reportlab (it lays out long
563
+ generated tables of sizes), the datasheet is Typst (it is a document that happens to
564
+ read data). Both take their numbers from the CSVs at build time.
565
+
566
  `container_stats.py` holds the per-vendor internal-dimension statistics that both
567
  `build.py` and the PDF report as fact, so the two cannot disagree about what a
568
  vendor publishes.
build.py CHANGED
@@ -10,6 +10,7 @@ Run: python3 build.py
10
 
11
  import csv
12
  import json
 
13
  import subprocess
14
  import sys
15
  from pathlib import Path
@@ -18,6 +19,7 @@ HERE = Path(__file__).parent
18
 
19
  sys.path.insert(0, str(HERE))
20
  import container_stats # noqa: E402 (needs HERE on the path)
 
21
 
22
  # ---------------------------------------------------------------------------
23
  # Internal-dimension rules.
@@ -325,22 +327,59 @@ with (HERE / "containers.jsonl").open("w", encoding="utf-8") as f:
325
  # `load_dataset` for anyone reading that field. Writing the frontmatter from the
326
  # same run that writes the data is the only way to keep the two in step.
327
 
328
- DTYPES = {
329
- **{k: "int64" for k in ("eur1_pallet_per_layer", "pack_quantity", "listings_observed",
330
- "internal_dims_vendors")},
331
- **{k: "bool" for k in (
332
- "lidded", "lid_available_separately", "nestable_when_empty",
333
- "standard_conformant", "vda_4500_height", "price_includes_vat")},
334
- **{k: "float64" for k in (
335
- "external_length_cm", "external_width_cm", "external_height_cm",
336
- "external_volume_l", "internal_length_cm", "internal_width_cm",
337
- "internal_height_cm", "typical_capacity_l", "vendor_capacity_low_l",
338
- "vendor_capacity_high_l", "usable_ratio",
339
- "typical_nesting_ratio", "stated_capacity_l", "price", "unit_price",
340
- "external_length_in", "external_width_in", "external_height_in",
341
- "internal_length_in", "internal_width_in", "internal_height_in",
342
- "external_volume_gal", "typical_capacity_gal", "stated_capacity_gal")},
343
- }
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
344
 
345
 
346
  def features(names, indent=" "):
@@ -392,14 +431,23 @@ dataset_info:
392
  ---"""
393
 
394
 
 
 
395
  readme = HERE / "README.md"
396
  if readme.exists():
397
  body = readme.read_text(encoding="utf-8")
398
  if body.startswith("---"):
399
  body = body.split("---", 2)[2].lstrip("\n")
 
 
 
 
 
 
400
  readme.write_text(frontmatter() + "\n\n" + body, encoding="utf-8")
401
 
402
  print(f"{len(ROWS)} rows -> containers.csv, containers.jsonl, README.md frontmatter")
 
403
  for kind in TYPE_LABELS:
404
  n = sum(1 for r in ROWS if r["type"] == kind)
405
  print(f" {kind}: {n}")
 
10
 
11
  import csv
12
  import json
13
+ import re
14
  import subprocess
15
  import sys
16
  from pathlib import Path
 
19
 
20
  sys.path.insert(0, str(HERE))
21
  import container_stats # noqa: E402 (needs HERE on the path)
22
+ import dictionary # noqa: E402
23
 
24
  # ---------------------------------------------------------------------------
25
  # Internal-dimension rules.
 
327
  # `load_dataset` for anyone reading that field. Writing the frontmatter from the
328
  # same run that writes the data is the only way to keep the two in step.
329
 
330
+ DTYPES = dictionary.DTYPES
331
+
332
+
333
+ def write_dictionary():
334
+ """Render the dictionary as a CSV and a document, and verify it matches."""
335
+ dictionary.check("containers", FIELDS)
336
+ with (HERE / "listings.csv").open(encoding="utf-8") as f:
337
+ dictionary.check("listings", next(csv.reader(f)))
338
+
339
+ rows = [
340
+ {"table": table, "file": fname, "column": name, "dtype": dtype,
341
+ "unit": unit, "description": desc}
342
+ for table, (fname, cols) in dictionary.TABLES.items()
343
+ for name, dtype, unit, desc in cols
344
+ ]
345
+ with (HERE / "data-dictionary.csv").open("w", newline="", encoding="utf-8") as f:
346
+ w = csv.DictWriter(f, fieldnames=list(rows[0]))
347
+ w.writeheader()
348
+ w.writerows(rows)
349
+
350
+ doc = [
351
+ "# Data dictionary\n\n",
352
+ f"Version {dictionary.VERSION}. Generated by `build.py` from `dictionary.py` "
353
+ "— do not hand-edit.\n\n",
354
+ "Every column in both tables, with its type, unit and meaning. The machine-"
355
+ "readable form of this file is [`data-dictionary.csv`](../data-dictionary.csv); "
356
+ "the same definitions render the dataset card's field table and the Hub's "
357
+ "dtype declarations, so the three cannot disagree.\n",
358
+ ]
359
+ for table, (fname, cols) in dictionary.TABLES.items():
360
+ doc.append(f"\n## `{table}` → `{fname}`\n")
361
+ doc.append(f"{len(cols)} columns.\n\n")
362
+ doc.append("| Column | Type | Unit | Description |\n|---|---|---|---|\n")
363
+ for name, dtype, unit, desc in cols:
364
+ doc.append(f"| `{name}` | {dtype} | {unit or '—'} | {desc} |\n")
365
+ (HERE / "docs").mkdir(exist_ok=True)
366
+ (HERE / "docs" / "data-dictionary.md").write_text("".join(doc), encoding="utf-8")
367
+
368
+ # The datasheet is a Typst document that reads the CSVs at compile time; the
369
+ # one thing it cannot get from them is the dictionary's version.
370
+ (HERE / "datasheet").mkdir(exist_ok=True)
371
+ (HERE / "datasheet" / "version.json").write_text(
372
+ json.dumps({"version": dictionary.VERSION}) + "\n", encoding="utf-8")
373
+ return rows
374
+
375
+
376
+ def fields_table():
377
+ """The dataset card's Fields section, rendered from the dictionary."""
378
+ out = ["| Field | Type | Notes |", "|---|---|---|"]
379
+ for name, dtype, unit, desc in dictionary.CONTAINERS:
380
+ u = f" ({unit})" if unit else ""
381
+ out.append(f"| `{name}` | {dtype}{u} | {desc} |")
382
+ return "\n".join(out)
383
 
384
 
385
  def features(names, indent=" "):
 
431
  ---"""
432
 
433
 
434
+ DICT_ROWS = write_dictionary()
435
+
436
  readme = HERE / "README.md"
437
  if readme.exists():
438
  body = readme.read_text(encoding="utf-8")
439
  if body.startswith("---"):
440
  body = body.split("---", 2)[2].lstrip("\n")
441
+ # The Fields table is rendered from dictionary.py, so replace whatever is
442
+ # between the heading and the next one rather than trusting it to be current.
443
+ body = re.sub(
444
+ r"(## Fields\n\n).*?(\n### )",
445
+ lambda m: m.group(1) + fields_table() + "\n" + m.group(2),
446
+ body, count=1, flags=re.S)
447
  readme.write_text(frontmatter() + "\n\n" + body, encoding="utf-8")
448
 
449
  print(f"{len(ROWS)} rows -> containers.csv, containers.jsonl, README.md frontmatter")
450
+ print(f"{len(DICT_ROWS)} columns -> data-dictionary.csv, docs/data-dictionary.md")
451
  for kind in TYPE_LABELS:
452
  n = sum(1 for r in ROWS if r["type"] == kind)
453
  print(f" {kind}: {n}")
data-dictionary.csv ADDED
@@ -0,0 +1,69 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ table,file,column,dtype,unit,description
2
+ containers,containers.csv,id,string,,"Stable slug, e.g. `euro-600x400x230`, `alc-600x400x310`, `vda-rklt-6429`"
3
+ containers,containers.csv,type,string,,`euro_stacking_container` · `attached_lid_container` · `vda_klt_container`
4
+ containers,containers.csv,type_label,string,,Human-readable form of `type`
5
+ containers,containers.csv,common_names,string,,"Semicolon-separated search terms, ordered most standard to most colloquial, including regional ones (`Eurobehälter`, `bac gerbable`) and genericised vendor names (`Hudson box`). Search terms only — never discriminate families on them, see `guidance/naming.md`"
6
+ containers,containers.csv,external_length_cm,float64,cm,External length
7
+ containers,containers.csv,external_width_cm,float64,cm,External width
8
+ containers,containers.csv,external_height_cm,float64,cm,External height
9
+ containers,containers.csv,external_length_in,float64,in,External length in inches. Always the derived side on this table — these nominal sizes are fixed in millimetres by the standards
10
+ containers,containers.csv,external_width_in,float64,in,"External width in inches, derived"
11
+ containers,containers.csv,external_height_in,float64,in,"External height in inches, derived"
12
+ containers,containers.csv,external_volume_l,float64,L,L × W × H. **Not** what the box holds
13
+ containers,containers.csv,external_volume_gal,float64,US gal,External volume in US liquid gallons
14
+ containers,containers.csv,internal_length_cm,float64,cm,"Typical internal length. Populated for every Euro row and for the two KLT sizes a vendor publishes; empty for ALCs, whose taper makes a single internal dimension meaningless"
15
+ containers,containers.csv,internal_width_cm,float64,cm,"Typical internal width, same basis"
16
+ containers,containers.csv,internal_height_cm,float64,cm,"Typical internal height, same basis"
17
+ containers,containers.csv,internal_length_in,float64,in,"Typical internal length in inches, derived"
18
+ containers,containers.csv,internal_width_in,float64,in,"Typical internal width in inches, derived"
19
+ containers,containers.csv,internal_height_in,float64,in,"Typical internal height in inches, derived"
20
+ containers,containers.csv,internal_dims_basis,string,,"Where those internal figures came from: `vendor_average_rule`, `vendor_published`, `not_published`, `not_published_tapered_walls`"
21
+ containers,containers.csv,internal_dims_vendors,int64,,"How many **vendors** publish internal dimensions for this footprint. Vendors, not listings — one mould in five colours is one opinion"
22
+ containers,containers.csv,typical_capacity_l,float64,L,**The usable number.** Always populated
23
+ containers,containers.csv,typical_capacity_gal,float64,US gal,Usable capacity in US liquid gallons
24
+ containers,containers.csv,vendor_capacity_low_l,float64,L,Capacity implied by the least generous vendor's own published internal dimensions for this footprint. Empty where no vendor publishes any
25
+ containers,containers.csv,vendor_capacity_high_l,float64,L,"As above, most generous vendor. See `guidance/internal-dimensions.md`"
26
+ containers,containers.csv,usable_ratio,float64,,`typical_capacity_l / external_volume_l`
27
+ containers,containers.csv,capacity_basis,string,,"How the capacity was arrived at: `derived_from_internal_dims`, `vendor_nominal`, `published`, `derived_from_klt_ratio`"
28
+ containers,containers.csv,lidded,bool,,True where a lid is integral to the product (ALCs)
29
+ containers,containers.csv,lid_available_separately,bool,,True where a lid exists but is a separate purchase
30
+ containers,containers.csv,nestable_when_empty,bool,,True for ALCs; straight-walled boxes stack but do not nest
31
+ containers,containers.csv,typical_nesting_ratio,float64,,"Fraction of its own height a nested empty box saves. 0.75 for ALCs, **0 for everything else** — that is a fact about a straight-walled box, not missing data"
32
+ containers,containers.csv,standard_conformant,bool,,Whether the footprint conforms to a recognised module
33
+ containers,containers.csv,standard,string,,"Which one, stated precisely"
34
+ containers,containers.csv,vda_4500_height,bool,,Whether the external height is on the VDA KLT grid (147.5 / 213 / 280 mm)
35
+ containers,containers.csv,eur1_pallet_per_layer,int64,,"Boxes per layer on a 1200 × 800 Euro pallet, no overhang. The one column that reaches past the box itself — see Scope"
36
+ containers,containers.csv,listings_observed,int64,,"How many rows in the `listings` table back this size — 0 means the row is a plausible interpolation, not something seen for sale"
37
+ containers,containers.csv,notes,string,,Per-row caveats. Read these
38
+ listings,listings.csv,listing_id,string,,"Stable slug, `<vendor>-<sku or handle>`"
39
+ listings,listings.csv,vendor,string,,Salesbridges · Plastic Box Shop · Yosibox · Hudson Exchange
40
+ listings,listings.csv,vendor_country,string,,ISO 3166-1 alpha-2 of the vendor's market
41
+ listings,listings.csv,product_name,string,,"The vendor's own product title, verbatim"
42
+ listings,listings.csv,sku,string,,"Vendor SKU where published, else empty"
43
+ listings,listings.csv,url,string,,"The listing, as captured on `captured_date`"
44
+ listings,listings.csv,type,string,,"Family, assigned by this project — not the vendor's word"
45
+ listings,listings.csv,native_unit,string,,"`metric` or `imperial`: which unit the vendor's own catalogue publishes in, and therefore which dimension columns are the figure and which are the conversion. See `guidance/units-and-us-vendors.md`"
46
+ listings,listings.csv,external_length_cm,float64,cm,External length as listed or converted
47
+ listings,listings.csv,external_width_cm,float64,cm,External width as listed or converted
48
+ listings,listings.csv,external_height_cm,float64,cm,External height as listed or converted
49
+ listings,listings.csv,external_length_in,float64,in,External length; the vendor's own figure where `native_unit` is `imperial`
50
+ listings,listings.csv,external_width_in,float64,in,"External width, same basis"
51
+ listings,listings.csv,external_height_in,float64,in,"External height, same basis"
52
+ listings,listings.csv,internal_length_cm,float64,cm,"Internal length **as the vendor publishes it**, empty where they do not. 95 of 121 rows carry these; vendors measure at different heights on a tapered box, which is why the typical table's figures are conservative"
53
+ listings,listings.csv,internal_width_cm,float64,cm,Internal width as published
54
+ listings,listings.csv,internal_height_cm,float64,cm,Internal height as published
55
+ listings,listings.csv,internal_length_in,float64,in,Internal length in inches
56
+ listings,listings.csv,internal_width_in,float64,in,Internal width in inches
57
+ listings,listings.csv,internal_height_in,float64,in,Internal height in inches
58
+ listings,listings.csv,stated_capacity_l,float64,L,The vendor's own capacity claim. Not recomputed — the point of this table is what they say
59
+ listings,listings.csv,stated_capacity_gal,float64,US gal,The same in US gallons; the vendor's own figure for Hudson Exchange
60
+ listings,listings.csv,external_volume_l,float64,L,"L × W × H, computed here"
61
+ listings,listings.csv,external_volume_gal,float64,US gal,The same in US gallons
62
+ listings,listings.csv,usable_ratio,float64,,"`stated_capacity_l / external_volume_l` — what **this** vendor claims, not what the typical table concluded"
63
+ listings,listings.csv,price,float64,,"As captured, in `currency`. An observation with a date on it, not a price feed"
64
+ listings,listings.csv,currency,string,,ISO 4217
65
+ listings,listings.csv,price_includes_vat,bool,,"Whether the captured price is VAT-inclusive. Differs by market — UK and NL retail inclusive, US exclusive"
66
+ listings,listings.csv,pack_quantity,int64,,Units in the pack the price refers to. Multipacks and pallet deals are common
67
+ listings,listings.csv,unit_price,float64,,`price / pack_quantity`
68
+ listings,listings.csv,captured_date,string,,ISO 8601 date the listing was read
69
+ listings,listings.csv,notes,string,,"Per-row caveats, including non-conforming footprints"
datasheet/build.sh ADDED
@@ -0,0 +1,10 @@
 
 
 
 
 
 
 
 
 
 
 
1
+ #!/usr/bin/env bash
2
+ # Build the datasheet PDF. Run build.py first — the datasheet reads the CSVs and
3
+ # version.json at compile time, so a stale build produces a stale datasheet.
4
+ set -euo pipefail
5
+ cd "$(dirname "$0")/.."
6
+ python3 build.py >/dev/null
7
+ V=$(python3 -c "import json;print(json.load(open('datasheet/version.json'))['version'])")
8
+ OUT="datasheet/storage-container-dimensions-datasheet-v${V}.pdf"
9
+ typst compile --root . datasheet/datasheet.typ "$OUT"
10
+ echo "$OUT"
datasheet/datasheet.typ ADDED
@@ -0,0 +1,276 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ // Datasheet for the storage-container-dimensions dataset.
2
+ //
3
+ // Reads data-dictionary.csv, containers.csv and listings.csv at compile time, so
4
+ // the schema, the counts and the vendor table cannot drift from the data. The only
5
+ // thing passed in is the dictionary version, in version.json, written by build.py.
6
+ //
7
+ // Compile with the repo as the root:
8
+ // ./datasheet/build.sh
9
+ // typst compile --root . datasheet/datasheet.typ datasheet/...-datasheet-v1.0.pdf
10
+
11
+ #let version = json("/datasheet/version.json").version
12
+ #let dict = csv("/data-dictionary.csv", row-type: dictionary)
13
+ #let containers = csv("/containers.csv", row-type: dictionary)
14
+ #let listings = csv("/listings.csv", row-type: dictionary)
15
+
16
+ #let ink = rgb("#16191d")
17
+ #let accent = rgb("#245c8c")
18
+ #let soft = rgb("#f1f4f7")
19
+ #let rule = rgb("#c7cdd4")
20
+
21
+ #set document(
22
+ title: "Industrial Storage Container Dimensions — datasheet v" + version,
23
+ author: "Daniel Rosehill",
24
+ )
25
+ #set page(
26
+ paper: "a4",
27
+ margin: (x: 19mm, top: 20mm, bottom: 18mm),
28
+ footer: context [
29
+ #set text(8pt, fill: gray)
30
+ #grid(
31
+ columns: (1fr, auto, 1fr),
32
+ align: (left, center, right),
33
+ [danielrosehill/storage-container-dimensions],
34
+ [datasheet v#version],
35
+ [#counter(page).display("1 / 1", both: true)],
36
+ )
37
+ ],
38
+ )
39
+ #set text(font: "IBM Plex Sans", size: 9.5pt, fill: ink,
40
+ number-type: "lining", number-width: "tabular")
41
+ #set par(justify: false, leading: 0.62em)
42
+ #show heading: set text(fill: accent)
43
+ #show heading.where(level: 1): it => block(above: 1.5em, below: 0.75em)[
44
+ #set text(14pt, weight: 600)
45
+ #it.body
46
+ #v(-0.45em)
47
+ #line(length: 100%, stroke: 0.6pt + rule)
48
+ ]
49
+ #show heading.where(level: 2): set text(10.5pt, weight: 600)
50
+ #show link: set text(fill: accent)
51
+ #show table.cell.where(y: 0): set text(weight: 600, size: 8pt)
52
+ #set table(
53
+ stroke: (x, y) => (
54
+ bottom: if y == 0 { 0.7pt + rule } else { 0.3pt + rule.lighten(35%) },
55
+ ),
56
+ fill: (x, y) => if y == 0 { soft },
57
+ inset: (x: 5pt, y: 4pt),
58
+ )
59
+
60
+ #let count(rows, pred) = rows.filter(pred).len()
61
+ #let uniq(rows, key) = {
62
+ let seen = ()
63
+ for r in rows { if not seen.contains(r.at(key)) { seen.push(r.at(key)) } }
64
+ seen
65
+ }
66
+
67
+ // --- cover -------------------------------------------------------------------
68
+
69
+ #block[
70
+ #text(8.5pt, fill: gray, weight: 600, tracking: 0.08em)[DATASET DATASHEET]
71
+ #v(0.35em)
72
+ #text(21pt, weight: 600, fill: accent)[Industrial Storage \ Container Dimensions]
73
+ #v(0.5em)
74
+ #text(10.5pt, fill: gray)[
75
+ Planning-grade volumetric reference for Euroboxes, attached-lid containers and
76
+ VDA 4500 KLTs — the plastic totes European and North American warehouses run on.
77
+ ]
78
+ ]
79
+
80
+ #v(0.8em)
81
+ #grid(
82
+ columns: (auto, 1fr),
83
+ gutter: 8pt,
84
+ row-gutter: 3pt,
85
+ text(fill: gray)[Version], [*#version*],
86
+ text(fill: gray)[Compiled], [#datetime.today().display("[day] [month repr:long] [year]")],
87
+ text(fill: gray)[Canonical], link("https://huggingface.co/datasets/danielrosehill/storage-container-dimensions")[huggingface.co/datasets/danielrosehill/storage-container-dimensions],
88
+ text(fill: gray)[Licence], [CC BY 4.0],
89
+ text(fill: gray)[Tables], [`containers.csv` — #containers.len() rows, #count(dict, r => r.table == "containers") columns · `listings.csv` — #listings.len() rows, #count(dict, r => r.table == "listings") columns],
90
+ )
91
+
92
+ #v(0.7em)
93
+ #block(fill: soft, inset: 9pt, radius: 3pt, width: 100%)[
94
+ *The one thing to take from this document.* The standards fix the *footprint*. They
95
+ do not fix internal dimensions, and they barely fix heights. Every internal
96
+ dimension and capacity here is a typical figure averaged across vendor catalogues,
97
+ good to roughly ±1 L on a 600 × 400 box — a planning number, not a specification.
98
+ Check the specific supplier's own figures before committing to a large order.
99
+ ]
100
+
101
+ = What it is for
102
+
103
+ The dataset stops at the unit: it describes the smallest standardised unit of
104
+ industrial storage and nothing above it. The calculations downstream are the
105
+ reader's, and in practice they are pallet load patterns, shelving and racking
106
+ layouts, consolidation and move planning, and ranking purchases on cost per
107
+ *usable* litre rather than on the nominal size printed on a listing.
108
+
109
+ #v(0.3em)
110
+ #table(
111
+ columns: (1fr, 1fr),
112
+ table.header[In scope][Out of scope],
113
+ [External and internal dimensions, both unit systems], [Pallet builds and load patterns],
114
+ [External volume and usable capacity], [Container loads, TEU utilisation, stowage],
115
+ [Nesting and stacking behaviour], [Shelving and racking layouts],
116
+ [Lid arrangement, standards conformance], [Live pricing, availability, lead times],
117
+ [What the trade calls each family, per geography], [Any one manufacturer's exact spec],
118
+ )
119
+
120
+ #v(0.3em)
121
+ The single deliberate exception is `eur1_pallet_per_layer`, the footprint count on a
122
+ 1200 × 800 deck. It is the last figure that is purely a property of the box; anything
123
+ past it depends on build height, pallet standard and container choice, which are
124
+ decisions rather than dimensions.
125
+
126
+ = Composition
127
+
128
+ == `containers.csv` — one typical row per nominal size
129
+
130
+ #let fam(t) = containers.filter(r => r.type == t)
131
+ #let heights(rows) = {
132
+ let h = uniq(rows, "external_height_cm").map(x => float(x)).sorted()
133
+ str(calc.min(..h)) + "–" + str(calc.max(..h)) + " cm, " + str(h.len()) + " values"
134
+ }
135
+ #table(
136
+ columns: (auto, auto, 1fr, auto),
137
+ align: (left, right, left, left),
138
+ table.header[Family][Rows][Footprints (cm)][External heights],
139
+ ..(("euro_stacking_container", "Euro stacking container"),
140
+ ("attached_lid_container", "Attached-lid container"),
141
+ ("vda_klt_container", "VDA 4500 KLT")).map(((key, label)) => {
142
+ let rows = fam(key)
143
+ (
144
+ [#label], [#rows.len()],
145
+ [#uniq(rows.map(r => (v: r.external_length_cm + " × " + r.external_width_cm)), "v").join(", ")],
146
+ [#heights(rows)],
147
+ )
148
+ }).flatten(),
149
+ )
150
+
151
+ Rows are nominal sizes, not products. A row exists where a size is either sold by a
152
+ captured vendor or is a defensible interpolation within a family's grid;
153
+ `listings_observed` says which, and a `0` there means nobody in `listings.csv` was
154
+ selling it.
155
+
156
+ == `listings.csv` — the observations behind them
157
+
158
+ #table(
159
+ columns: (1fr, auto, auto, auto, auto, auto),
160
+ align: (left, left, right, right, right, left),
161
+ table.header[Vendor][Market][Listings][Publishes internals][Native unit][Captured],
162
+ ..uniq(listings, "vendor").sorted().map(v => {
163
+ let rows = listings.filter(r => r.vendor == v)
164
+ (
165
+ [#v], [#rows.at(0).vendor_country], [#rows.len()],
166
+ [#count(rows, r => r.internal_length_cm != "")],
167
+ [#rows.at(0).native_unit],
168
+ [#uniq(rows, "captured_date").map(d => d.slice(0, 10)).join(", ")],
169
+ )
170
+ }).flatten(),
171
+ )
172
+
173
+ This table exists so the first one can be audited. Every typical capacity is a
174
+ judgement about a spread of real products; these are the products, with URLs and
175
+ capture dates, so a reader who disagrees with a figure can see what it was
176
+ generalised from. Prices are captured observations with a date on them — kept to make
177
+ a capacity auditable against what was really on sale, not a price feed, and they rot.
178
+
179
+ = How the numbers were derived
180
+
181
+ *Straight-walled boxes.* Internal dimensions follow a per-footprint rule averaged
182
+ across vendor catalogues — for 600 × 400, internally 550 × 355 mm with the height less
183
+ 15 mm — and capacity is computed from those. The rule sits deliberately at the
184
+ conservative end of the published range.
185
+
186
+ *Attached-lid containers.* The taper means no single internal L × W × H is right
187
+ wherever you measure it, and no captured vendor publishes one for a 600 × 400 or
188
+ 400 × 300 ALC. Capacity is the manufacturer's nominal figure, which is the only
189
+ honest number available; `internal_*` is empty and `internal_dims_basis` says
190
+ `not_published_tapered_walls`.
191
+
192
+ *VDA KLTs.* Thicker-walled than consumer Euroboxes, so the straight-wall rule does not
193
+ transfer. Where a vendor publishes internals for the exact size they are used;
194
+ elsewhere capacity is derived from the one published pair (R-KLT 6429, 600 × 400 × 280
195
+ external = 67.2 L, 48 L internal) and `capacity_basis` says so.
196
+
197
+ *Both unit systems, on every row.* Dimensions in centimetres and inches, capacity in
198
+ litres and US gallons. On `listings.csv`, `native_unit` records which side is the
199
+ vendor's own figure and which is the conversion — the derived side is rounded, so a
200
+ US vendor's own 19.6 in read back from a 1 dp centimetre value becomes 19.61.
201
+
202
+ = Known limitations
203
+
204
+ / Internal dimensions are not standardised: Wall thickness, draft angle and rib design
205
+ are the manufacturer's choice. Across the four captured catalogues a
206
+ 60 × 40 × 32 cm Eurobox is quoted internally at anything from 60.4 to 66.4 L — an
207
+ 11 % range on a box all of them call 600 × 400 × 320. `vendor_capacity_low_l` and
208
+ `vendor_capacity_high_l` carry that range on every row rather than hiding it.
209
+
210
+ / Heights are convention, not standard: Of the #count(containers, r => r.type == "euro_stacking_container" and r.external_length_cm == "60.0" and r.external_width_cm == "40.0") distinct
211
+ 600 × 400 heights here, exactly one — 280 mm — is fixed by a standard (VDA 4500).
212
+ The rest are what manufacturers happen to make, and one-off variants exist.
213
+
214
+ / Inch-designed totes near-miss the module: US vendors design to inches and land close
215
+ to 600 × 400 without hitting it. Hudson Exchange's 24 × 15 in straight-wall tote is
216
+ 61.0 × 38.1 cm — one centimetre too long to put four on a Euro pallet, so the layer
217
+ pattern collapses from 4 to 2. Filter on the footprint in millimetres, never on a
218
+ product being called an industrial tote.
219
+
220
+ / The 800 × 600 rows are the weakest: They are formula-derived, and the only vendor
221
+ publishing internals for that footprint implies 8–9 % more capacity than the rule
222
+ gives. Treat them as conservative.
223
+
224
+ / Four vendors, three markets, one capture window: NL, GB, IL and US, captured July
225
+ 2026. This is not a census of the market, and Asian manufacturers are absent.
226
+
227
+ = Provenance and reproducibility
228
+
229
+ Vendor catalogues were captured from the storefronts' own JSON endpoints — Shopify
230
+ `/products.json` for the UK and US vendors, Lightspeed `?format=json` for the Dutch
231
+ one — and the trimmed captures are committed under `raw/`. The builders never touch
232
+ the network, so a rebuild reproduces the same tables from the same snapshots.
233
+
234
+ #v(0.3em)
235
+ #table(
236
+ columns: (auto, 1fr),
237
+ align: (left, left),
238
+ table.header[Step][Command],
239
+ [Listings from the snapshots], [`python3 build_listings.py`],
240
+ [Typical rows, dictionary, card], [`python3 build.py`],
241
+ [Printable dimensional reference], [`python3 scripts/build_reference_pdf.py`],
242
+ [This datasheet], [`./datasheet/build.sh`],
243
+ )
244
+
245
+ #v(0.3em)
246
+ `build.py` renders the data dictionary four ways — `data-dictionary.csv`,
247
+ `docs/data-dictionary.md`, the dataset card's field table and the Hub's dtype
248
+ frontmatter — and fails if a builder emits a column the dictionary does not document.
249
+ The schema and its documentation cannot drift apart.
250
+
251
+ #pagebreak()
252
+
253
+ = Data dictionary
254
+
255
+ Version #version. Every column in both tables. Rendered from `data-dictionary.csv`,
256
+ which is itself generated from `dictionary.py`.
257
+
258
+ #set text(8.5pt)
259
+ // `tbl`, not `table` — a loop variable named `table` shadows the built-in table
260
+ // function and every table.header below it stops resolving.
261
+ #for (tbl, fname) in (("containers", "containers.csv"), ("listings", "listings.csv")) [
262
+ == #raw(tbl) → #raw(fname) // backticks would make #tbl a literal raw span
263
+
264
+ #let cols = dict.filter(r => r.table == tbl)
265
+ #table(
266
+ columns: (auto, auto, auto, 1fr),
267
+ align: (left, left, left, left),
268
+ table.header[Column][Type][Unit][Description],
269
+ ..cols.map(c => (
270
+ raw(c.column), [#c.dtype], [#if c.unit == "" { "—" } else { c.unit }],
271
+ // Descriptions are authored as markdown for the card and the .md doc, where
272
+ // bold is **x**; Typst markup uses *x* and renders ** as empty stars.
273
+ eval(c.description.replace("**", "*"), mode: "markup"),
274
+ )).flatten(),
275
+ )
276
+ ]
datasheet/storage-container-dimensions-datasheet-v1.0.pdf ADDED
The diff for this file is too large to render. See raw diff
 
datasheet/version.json ADDED
@@ -0,0 +1 @@
 
 
1
+ {"version": "1.0"}
dictionary.py ADDED
@@ -0,0 +1,163 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ #!/usr/bin/env python3
2
+ """The data dictionary — one definition per column, for both tables.
3
+
4
+ Authoritative. build.py renders it four ways and none of them is hand-written:
5
+
6
+ data-dictionary.csv machine-readable, one row per column
7
+ docs/data-dictionary.md the same as a document
8
+ README.md "Fields" table the dataset card
9
+ README.md frontmatter the Hub's dtype declarations
10
+
11
+ Adding a column to a builder without adding it here fails the build, which is the
12
+ point: the schema and its documentation cannot drift apart.
13
+
14
+ `unit` is the physical unit or "" for dimensionless and categorical columns.
15
+ `example` is illustrative, not drawn from the data.
16
+ """
17
+
18
+ VERSION = "1.0"
19
+
20
+ # (name, dtype, unit, description)
21
+ CONTAINERS = [
22
+ ("id", "string", "",
23
+ "Stable slug, e.g. `euro-600x400x230`, `alc-600x400x310`, `vda-rklt-6429`"),
24
+ ("type", "string", "",
25
+ "`euro_stacking_container` · `attached_lid_container` · `vda_klt_container`"),
26
+ ("type_label", "string", "", "Human-readable form of `type`"),
27
+ ("common_names", "string", "",
28
+ "Semicolon-separated search terms, ordered most standard to most colloquial, "
29
+ "including regional ones (`Eurobehälter`, `bac gerbable`) and genericised vendor "
30
+ "names (`Hudson box`). Search terms only — never discriminate families on them, "
31
+ "see `guidance/naming.md`"),
32
+ ("external_length_cm", "float64", "cm", "External length"),
33
+ ("external_width_cm", "float64", "cm", "External width"),
34
+ ("external_height_cm", "float64", "cm", "External height"),
35
+ ("external_length_in", "float64", "in",
36
+ "External length in inches. Always the derived side on this table — these "
37
+ "nominal sizes are fixed in millimetres by the standards"),
38
+ ("external_width_in", "float64", "in", "External width in inches, derived"),
39
+ ("external_height_in", "float64", "in", "External height in inches, derived"),
40
+ ("external_volume_l", "float64", "L", "L × W × H. **Not** what the box holds"),
41
+ ("external_volume_gal", "float64", "US gal", "External volume in US liquid gallons"),
42
+ ("internal_length_cm", "float64", "cm",
43
+ "Typical internal length. Populated for every Euro row and for the two KLT sizes "
44
+ "a vendor publishes; empty for ALCs, whose taper makes a single internal "
45
+ "dimension meaningless"),
46
+ ("internal_width_cm", "float64", "cm", "Typical internal width, same basis"),
47
+ ("internal_height_cm", "float64", "cm", "Typical internal height, same basis"),
48
+ ("internal_length_in", "float64", "in", "Typical internal length in inches, derived"),
49
+ ("internal_width_in", "float64", "in", "Typical internal width in inches, derived"),
50
+ ("internal_height_in", "float64", "in", "Typical internal height in inches, derived"),
51
+ ("internal_dims_basis", "string", "",
52
+ "Where those internal figures came from: `vendor_average_rule`, "
53
+ "`vendor_published`, `not_published`, `not_published_tapered_walls`"),
54
+ ("internal_dims_vendors", "int64", "",
55
+ "How many **vendors** publish internal dimensions for this footprint. Vendors, "
56
+ "not listings — one mould in five colours is one opinion"),
57
+ ("typical_capacity_l", "float64", "L", "**The usable number.** Always populated"),
58
+ ("typical_capacity_gal", "float64", "US gal",
59
+ "Usable capacity in US liquid gallons"),
60
+ ("vendor_capacity_low_l", "float64", "L",
61
+ "Capacity implied by the least generous vendor's own published internal "
62
+ "dimensions for this footprint. Empty where no vendor publishes any"),
63
+ ("vendor_capacity_high_l", "float64", "L",
64
+ "As above, most generous vendor. See `guidance/internal-dimensions.md`"),
65
+ ("usable_ratio", "float64", "",
66
+ "`typical_capacity_l / external_volume_l`"),
67
+ ("capacity_basis", "string", "",
68
+ "How the capacity was arrived at: `derived_from_internal_dims`, "
69
+ "`vendor_nominal`, `published`, `derived_from_klt_ratio`"),
70
+ ("lidded", "bool", "", "True where a lid is integral to the product (ALCs)"),
71
+ ("lid_available_separately", "bool", "",
72
+ "True where a lid exists but is a separate purchase"),
73
+ ("nestable_when_empty", "bool", "",
74
+ "True for ALCs; straight-walled boxes stack but do not nest"),
75
+ ("typical_nesting_ratio", "float64", "",
76
+ "Fraction of its own height a nested empty box saves. 0.75 for ALCs, **0 for "
77
+ "everything else** — that is a fact about a straight-walled box, not missing data"),
78
+ ("standard_conformant", "bool", "",
79
+ "Whether the footprint conforms to a recognised module"),
80
+ ("standard", "string", "", "Which one, stated precisely"),
81
+ ("vda_4500_height", "bool", "",
82
+ "Whether the external height is on the VDA KLT grid (147.5 / 213 / 280 mm)"),
83
+ ("eur1_pallet_per_layer", "int64", "",
84
+ "Boxes per layer on a 1200 × 800 Euro pallet, no overhang. The one column that "
85
+ "reaches past the box itself — see Scope"),
86
+ ("listings_observed", "int64", "",
87
+ "How many rows in the `listings` table back this size — 0 means the row is a "
88
+ "plausible interpolation, not something seen for sale"),
89
+ ("notes", "string", "", "Per-row caveats. Read these"),
90
+ ]
91
+
92
+ LISTINGS = [
93
+ ("listing_id", "string", "", "Stable slug, `<vendor>-<sku or handle>`"),
94
+ ("vendor", "string", "",
95
+ "Salesbridges · Plastic Box Shop · Yosibox · Hudson Exchange"),
96
+ ("vendor_country", "string", "", "ISO 3166-1 alpha-2 of the vendor's market"),
97
+ ("product_name", "string", "", "The vendor's own product title, verbatim"),
98
+ ("sku", "string", "", "Vendor SKU where published, else empty"),
99
+ ("url", "string", "", "The listing, as captured on `captured_date`"),
100
+ ("type", "string", "", "Family, assigned by this project — not the vendor's word"),
101
+ ("native_unit", "string", "",
102
+ "`metric` or `imperial`: which unit the vendor's own catalogue publishes in, and "
103
+ "therefore which dimension columns are the figure and which are the conversion. "
104
+ "See `guidance/units-and-us-vendors.md`"),
105
+ ("external_length_cm", "float64", "cm", "External length as listed or converted"),
106
+ ("external_width_cm", "float64", "cm", "External width as listed or converted"),
107
+ ("external_height_cm", "float64", "cm", "External height as listed or converted"),
108
+ ("external_length_in", "float64", "in", "External length; the vendor's own figure where `native_unit` is `imperial`"),
109
+ ("external_width_in", "float64", "in", "External width, same basis"),
110
+ ("external_height_in", "float64", "in", "External height, same basis"),
111
+ ("internal_length_cm", "float64", "cm",
112
+ "Internal length **as the vendor publishes it**, empty where they do not. 95 of "
113
+ "121 rows carry these; vendors measure at different heights on a tapered box, "
114
+ "which is why the typical table's figures are conservative"),
115
+ ("internal_width_cm", "float64", "cm", "Internal width as published"),
116
+ ("internal_height_cm", "float64", "cm", "Internal height as published"),
117
+ ("internal_length_in", "float64", "in", "Internal length in inches"),
118
+ ("internal_width_in", "float64", "in", "Internal width in inches"),
119
+ ("internal_height_in", "float64", "in", "Internal height in inches"),
120
+ ("stated_capacity_l", "float64", "L",
121
+ "The vendor's own capacity claim. Not recomputed — the point of this table is "
122
+ "what they say"),
123
+ ("stated_capacity_gal", "float64", "US gal",
124
+ "The same in US gallons; the vendor's own figure for Hudson Exchange"),
125
+ ("external_volume_l", "float64", "L", "L × W × H, computed here"),
126
+ ("external_volume_gal", "float64", "US gal", "The same in US gallons"),
127
+ ("usable_ratio", "float64", "",
128
+ "`stated_capacity_l / external_volume_l` — what **this** vendor claims, not what "
129
+ "the typical table concluded"),
130
+ ("price", "float64", "",
131
+ "As captured, in `currency`. An observation with a date on it, not a price feed"),
132
+ ("currency", "string", "", "ISO 4217"),
133
+ ("price_includes_vat", "bool", "",
134
+ "Whether the captured price is VAT-inclusive. Differs by market — UK and NL "
135
+ "retail inclusive, US exclusive"),
136
+ ("pack_quantity", "int64", "",
137
+ "Units in the pack the price refers to. Multipacks and pallet deals are common"),
138
+ ("unit_price", "float64", "", "`price / pack_quantity`"),
139
+ ("captured_date", "string", "", "ISO 8601 date the listing was read"),
140
+ ("notes", "string", "", "Per-row caveats, including non-conforming footprints"),
141
+ ]
142
+
143
+ TABLES = {
144
+ "containers": ("containers.csv", CONTAINERS),
145
+ "listings": ("listings.csv", LISTINGS),
146
+ }
147
+
148
+ DTYPES = {name: dtype for _, cols in TABLES.values() for name, dtype, _, _ in cols}
149
+
150
+
151
+ def check(table: str, fields: list[str]) -> None:
152
+ """Fail the build if a builder's columns and this dictionary disagree."""
153
+ _, cols = TABLES[table]
154
+ documented = [c[0] for c in cols]
155
+ if documented != list(fields):
156
+ missing = [f for f in fields if f not in documented]
157
+ extra = [f for f in documented if f not in fields]
158
+ raise SystemExit(
159
+ f"{table}: dictionary and CSV columns disagree.\n"
160
+ f" undocumented in dictionary.py: {missing or 'none'}\n"
161
+ f" documented but not emitted: {extra or 'none'}\n"
162
+ f" (order matters too — CSV order is {list(fields)})"
163
+ )
docs/data-dictionary.md ADDED
@@ -0,0 +1,85 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Data dictionary
2
+
3
+ Version 1.0. Generated by `build.py` from `dictionary.py` — do not hand-edit.
4
+
5
+ Every column in both tables, with its type, unit and meaning. The machine-readable form of this file is [`data-dictionary.csv`](../data-dictionary.csv); the same definitions render the dataset card's field table and the Hub's dtype declarations, so the three cannot disagree.
6
+
7
+ ## `containers` → `containers.csv`
8
+ 36 columns.
9
+
10
+ | Column | Type | Unit | Description |
11
+ |---|---|---|---|
12
+ | `id` | string | — | Stable slug, e.g. `euro-600x400x230`, `alc-600x400x310`, `vda-rklt-6429` |
13
+ | `type` | string | — | `euro_stacking_container` · `attached_lid_container` · `vda_klt_container` |
14
+ | `type_label` | string | — | Human-readable form of `type` |
15
+ | `common_names` | string | — | Semicolon-separated search terms, ordered most standard to most colloquial, including regional ones (`Eurobehälter`, `bac gerbable`) and genericised vendor names (`Hudson box`). Search terms only — never discriminate families on them, see `guidance/naming.md` |
16
+ | `external_length_cm` | float64 | cm | External length |
17
+ | `external_width_cm` | float64 | cm | External width |
18
+ | `external_height_cm` | float64 | cm | External height |
19
+ | `external_length_in` | float64 | in | External length in inches. Always the derived side on this table — these nominal sizes are fixed in millimetres by the standards |
20
+ | `external_width_in` | float64 | in | External width in inches, derived |
21
+ | `external_height_in` | float64 | in | External height in inches, derived |
22
+ | `external_volume_l` | float64 | L | L × W × H. **Not** what the box holds |
23
+ | `external_volume_gal` | float64 | US gal | External volume in US liquid gallons |
24
+ | `internal_length_cm` | float64 | cm | Typical internal length. Populated for every Euro row and for the two KLT sizes a vendor publishes; empty for ALCs, whose taper makes a single internal dimension meaningless |
25
+ | `internal_width_cm` | float64 | cm | Typical internal width, same basis |
26
+ | `internal_height_cm` | float64 | cm | Typical internal height, same basis |
27
+ | `internal_length_in` | float64 | in | Typical internal length in inches, derived |
28
+ | `internal_width_in` | float64 | in | Typical internal width in inches, derived |
29
+ | `internal_height_in` | float64 | in | Typical internal height in inches, derived |
30
+ | `internal_dims_basis` | string | — | Where those internal figures came from: `vendor_average_rule`, `vendor_published`, `not_published`, `not_published_tapered_walls` |
31
+ | `internal_dims_vendors` | int64 | — | How many **vendors** publish internal dimensions for this footprint. Vendors, not listings — one mould in five colours is one opinion |
32
+ | `typical_capacity_l` | float64 | L | **The usable number.** Always populated |
33
+ | `typical_capacity_gal` | float64 | US gal | Usable capacity in US liquid gallons |
34
+ | `vendor_capacity_low_l` | float64 | L | Capacity implied by the least generous vendor's own published internal dimensions for this footprint. Empty where no vendor publishes any |
35
+ | `vendor_capacity_high_l` | float64 | L | As above, most generous vendor. See `guidance/internal-dimensions.md` |
36
+ | `usable_ratio` | float64 | — | `typical_capacity_l / external_volume_l` |
37
+ | `capacity_basis` | string | — | How the capacity was arrived at: `derived_from_internal_dims`, `vendor_nominal`, `published`, `derived_from_klt_ratio` |
38
+ | `lidded` | bool | — | True where a lid is integral to the product (ALCs) |
39
+ | `lid_available_separately` | bool | — | True where a lid exists but is a separate purchase |
40
+ | `nestable_when_empty` | bool | — | True for ALCs; straight-walled boxes stack but do not nest |
41
+ | `typical_nesting_ratio` | float64 | — | Fraction of its own height a nested empty box saves. 0.75 for ALCs, **0 for everything else** — that is a fact about a straight-walled box, not missing data |
42
+ | `standard_conformant` | bool | — | Whether the footprint conforms to a recognised module |
43
+ | `standard` | string | — | Which one, stated precisely |
44
+ | `vda_4500_height` | bool | — | Whether the external height is on the VDA KLT grid (147.5 / 213 / 280 mm) |
45
+ | `eur1_pallet_per_layer` | int64 | — | Boxes per layer on a 1200 × 800 Euro pallet, no overhang. The one column that reaches past the box itself — see Scope |
46
+ | `listings_observed` | int64 | — | How many rows in the `listings` table back this size — 0 means the row is a plausible interpolation, not something seen for sale |
47
+ | `notes` | string | — | Per-row caveats. Read these |
48
+
49
+ ## `listings` → `listings.csv`
50
+ 32 columns.
51
+
52
+ | Column | Type | Unit | Description |
53
+ |---|---|---|---|
54
+ | `listing_id` | string | — | Stable slug, `<vendor>-<sku or handle>` |
55
+ | `vendor` | string | — | Salesbridges · Plastic Box Shop · Yosibox · Hudson Exchange |
56
+ | `vendor_country` | string | — | ISO 3166-1 alpha-2 of the vendor's market |
57
+ | `product_name` | string | — | The vendor's own product title, verbatim |
58
+ | `sku` | string | — | Vendor SKU where published, else empty |
59
+ | `url` | string | — | The listing, as captured on `captured_date` |
60
+ | `type` | string | — | Family, assigned by this project — not the vendor's word |
61
+ | `native_unit` | string | — | `metric` or `imperial`: which unit the vendor's own catalogue publishes in, and therefore which dimension columns are the figure and which are the conversion. See `guidance/units-and-us-vendors.md` |
62
+ | `external_length_cm` | float64 | cm | External length as listed or converted |
63
+ | `external_width_cm` | float64 | cm | External width as listed or converted |
64
+ | `external_height_cm` | float64 | cm | External height as listed or converted |
65
+ | `external_length_in` | float64 | in | External length; the vendor's own figure where `native_unit` is `imperial` |
66
+ | `external_width_in` | float64 | in | External width, same basis |
67
+ | `external_height_in` | float64 | in | External height, same basis |
68
+ | `internal_length_cm` | float64 | cm | Internal length **as the vendor publishes it**, empty where they do not. 95 of 121 rows carry these; vendors measure at different heights on a tapered box, which is why the typical table's figures are conservative |
69
+ | `internal_width_cm` | float64 | cm | Internal width as published |
70
+ | `internal_height_cm` | float64 | cm | Internal height as published |
71
+ | `internal_length_in` | float64 | in | Internal length in inches |
72
+ | `internal_width_in` | float64 | in | Internal width in inches |
73
+ | `internal_height_in` | float64 | in | Internal height in inches |
74
+ | `stated_capacity_l` | float64 | L | The vendor's own capacity claim. Not recomputed — the point of this table is what they say |
75
+ | `stated_capacity_gal` | float64 | US gal | The same in US gallons; the vendor's own figure for Hudson Exchange |
76
+ | `external_volume_l` | float64 | L | L × W × H, computed here |
77
+ | `external_volume_gal` | float64 | US gal | The same in US gallons |
78
+ | `usable_ratio` | float64 | — | `stated_capacity_l / external_volume_l` — what **this** vendor claims, not what the typical table concluded |
79
+ | `price` | float64 | — | As captured, in `currency`. An observation with a date on it, not a price feed |
80
+ | `currency` | string | — | ISO 4217 |
81
+ | `price_includes_vat` | bool | — | Whether the captured price is VAT-inclusive. Differs by market — UK and NL retail inclusive, US exclusive |
82
+ | `pack_quantity` | int64 | — | Units in the pack the price refers to. Multipacks and pallet deals are common |
83
+ | `unit_price` | float64 | — | `price / pack_quantity` |
84
+ | `captured_date` | string | — | ISO 8601 date the listing was read |
85
+ | `notes` | string | — | Per-row caveats, including non-conforming footprints |