Skip to main content

Photometric datasheet generator (HTML + PDF) from EULUMDAT .ldt files

Project description

eulumdat-report

PyPI version Python License: MIT

Photometric datasheet generator (HTML + PDF) from EULUMDAT .ldt files — orchestrates the full eulumdat-* ecosystem.

Features

  • Single-page A4 datasheet from any EULUMDAT .ldt file
  • Polar intensity diagram (cd/klm) — eulumdat-plot
  • Polar luminance diagram (cd/m²) + maximum luminance — eulumdat-luminance
  • UGR catalogue table (CIE 117 / CIE 190, 19 rooms × 5 reflectances × 2 directions) — eulumdat-ugr
  • Half-angles and FWHM per C-plane — eulumdat-analysis
  • HTML output (self-contained, browser-ready A4 preview)
  • PDF output via Playwright / Chromium (cross-platform — see installation notes)
  • Custom Jinja2 template support
  • CLI and Python API

Installation

pip install eulumdat-report

PDF output

PDF rendering uses Playwright (Chromium headless). After installing the package, download the Chromium browser once:

playwright install chromium

This step is required on all platforms (Windows, Linux, macOS). HTML output works without it.

Quick start

CLI

# HTML + PDF
eulumdat-report luminaire.ldt

# HTML only, custom output directory
eulumdat-report luminaire.ldt --no-pdf --output-dir reports/

# All options
eulumdat-report --help

Python API

from eulumdat_report.collector import ReportCollector
from eulumdat_report.renderer import ReportRenderer
from pathlib import Path

data = ReportCollector.collect("luminaire.ldt")
html = ReportRenderer.render_html(data)
Path("luminaire.html").write_text(html, encoding="utf-8")

# PDF (requires: playwright install chromium)
ReportRenderer.render_pdf(data, Path("luminaire.pdf"))

CLI reference

Usage: eulumdat-report [OPTIONS] LDT_FILE

  Generate a photometric datasheet (HTML/PDF) from an EULUMDAT .ldt file.

Options:
  -o, --output-dir DIRECTORY  Output directory  [default: same as LDT_FILE]
  --template FILE             Custom Jinja2 HTML template
  --html / --no-html          Generate HTML output  [default: html]
  --pdf  / --no-pdf           Generate PDF output   [default: pdf]
  -v, --verbose               Enable debug logging
  --help                      Show this message and exit

Output filenames are derived from the input basename: luminaire.ldtluminaire.html / luminaire.pdf.

Template customisation

The default template is src/eulumdat_report/templates/default.html with companion default.css. To customise, copy both files to a local directory and pass --template to the CLI:

eulumdat-report luminaire.ldt --template my_templates/custom.html

The template receives a single data object (ReportData dataclass). The following Jinja2 filters are available:

Filter Description Example
thousands Space-separated thousands (int) 1233412 334
fmt1 1 decimal place 184.6
ugr_fmt 1 decimal or if None 18.0 /
svg_responsive Makes SVG responsive (adds viewBox, sets width=100%)

SVG fields are embedded inline: {{ data.svg_intensity \| svg_responsive \| safe }}.

Key data fields

data.luminaire_name      # str
data.company             # str
data.luminaire_number    # str
data.isym                # int  (0–4)
data.mc, data.ng         # int  (C-planes, gamma angles)
data.lamp_flux           # float (lm)
data.lamp_watt           # float (W)
data.lorl                # float (%)
data.lum_max             # float | None (cd/m²)
data.svg_intensity       # str | None
data.svg_luminance       # str | None
data.ugr                 # UgrTableData | None

Dependencies

Package Role
eulumdat-py EULUMDAT parser
eulumdat-plot Polar intensity diagram (SVG)
eulumdat-luminance Polar luminance diagram (SVG) + maximum
eulumdat-ugr UGR catalogue table
eulumdat-analysis Half-angles, FWHM
jinja2 HTML templating
playwright PDF rendering (Chromium headless)
click CLI

Running the tests

pip install -e ".[dev]"
pytest

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

eulumdat_report-1.0.1.tar.gz (19.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

eulumdat_report-1.0.1-py3-none-any.whl (15.4 kB view details)

Uploaded Python 3

File details

Details for the file eulumdat_report-1.0.1.tar.gz.

File metadata

  • Download URL: eulumdat_report-1.0.1.tar.gz
  • Upload date:
  • Size: 19.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.11

File hashes

Hashes for eulumdat_report-1.0.1.tar.gz
Algorithm Hash digest
SHA256 8cecabc2502d8031543e2f05362c618eb990fb293229dd95360cf75a01069eed
MD5 4fd54e54232e44522c6ac627bcdb50de
BLAKE2b-256 e2a964f0d86f3df98771fc700f3d4bcd1e6039f4b5f06caaf7fabf65843424c8

See more details on using hashes here.

File details

Details for the file eulumdat_report-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for eulumdat_report-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7ff42106350ec9f24def1e35afcb16e1d0326946b79b317928a4741337a1e6ac
MD5 45ad39b76b9f21dd30e5dea8badf6f79
BLAKE2b-256 4743d5efa9b0610f97a70e760a35a8fed613cc9e6571b042ea67ad790617109d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page