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
14 changes: 14 additions & 0 deletions docs/api/scene.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Scene

Resolving a model's geometry into one frame, without changing the model.

`get_scene(doc)` returns every surface it could place, in world coordinates with
the building rotation applied, alongside what it could not place and what it did
not attempt. It reads; it does not author, validate or mutate. Writing the
document before and after yields the same bytes.

The resolution it applies was measured against EnergyPlus's own surface vertex
report rather than reasoned from the input reference, which is why
[`translate_to_world`][idfkit.geometry.translate_to_world] now agrees with it.

::: idfkit.scene
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@ nav:
- Schema: api/schema.md
- Validation: api/validation.md
- Geometry: api/geometry.md
- Scene: api/scene.md
- Geometry Builders: api/geometry_builders.md
- Surface Matching: api/surface_matching.md
- Zoning: api/zoning.md
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ version = "0.0.0"
description = "The unified idfkit documentation site"
requires-python = ">=3.12"
dependencies = [
"idfkit==1.0.0-rc.4",
"idfkit==1.0.0-rc.6",
]

[tool.uv]
Expand Down Expand Up @@ -88,7 +88,7 @@ level = "docs-2026.5"
# four weather-browser files out of the same one. Pinning it is what keeps the reference and the
# assets on a page describing the same version of the library.
[tool.idfkit.library]
level = "1.0.0-rc.4"
level = "1.0.0-rc.6"

[tool.pyright]
pythonVersion = "3.12"
Expand Down
8 changes: 7 additions & 1 deletion scripts/check_engine_assets.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,13 @@
("static import", re.compile(r"^\s*import\s[^;\n]*['\"][^'\"]*@idfkit/engine", re.M)),
)

TEXT_SUFFIXES = frozenset({".html", ".js", ".css", ".mjs"})
#: Text the site generates, exempt from the size rule above because their size is a fact about how
#: much documentation there is rather than evidence of a stray binary. `.json` is here for the
#: search index, which mkdocs writes from every page's text and which crossed LARGE_BINARY_BYTES
#: when the scene module gained a reference page: 8.4 MB of prose, reported as a stray binary in
#: the same output that reported zero WebAssembly files. Engine bytes cannot hide here, because
#: BINARY_SUFFIXES catches `.wasm` and `.wat` at any size and the size rule is only a backstop.
TEXT_SUFFIXES = frozenset({".html", ".js", ".css", ".mjs", ".json"})


def hosted_binaries(site: Path) -> list[str]:
Expand Down
8 changes: 4 additions & 4 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading