render()

Render a geometry as an SVG, looking down the z axis (x right, y up).

Usage

Source

render(
    geo,
    out=None,
    *,
    config=STYLE,
)

Parameters

geo: Geometry

Geometry.

out: str | Path | None = None

Output path. The suffix is replaced with .svg.

config: xyzrender.RenderConfig = STYLE

xyzrender configuration.

Returns

xyzrender.SVGResult

The SVG, which displays inline in Jupyter-like REPLs.