Skip to main content

This library can be used to render OpenVCAD objects. See the main OpenVCAD package for more info.

Mermaid Tree Diagrams

pyvcad_rendering.render_tree_diagram(...) and Render_Tree_Diagram(...) save authored OpenVCAD tree diagrams from a root tree in one call. pyvcad_rendering.render_tree_legend(...) and Render_Tree_Legend(...) do the same for the built-in master legend.

Install the Mermaid CLI separately and ensure mmdc is available on your PATH:

mmdc -i input.mmd -o output.svg

The tree helper accepts either a root pyvcad.Node or a pre-built pyvcad.TreeDiagram.

  • If output_path ends in .mmd, the Mermaid source is written directly.
  • If output_path ends in .svg or .png, the helper writes a temporary .mmd and shells out to mmdc.

pyvcad.TreeDiagram.master_legend() returns a hardcoded annotated master legend for the broader OpenVCAD tree-diagram language, and pyvcad.TreeDiagram.save_master_legend(path) writes that Mermaid source to disk.

Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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

pyvcad_rendering-3.0.2-py3-none-any.whl (161.6 kB view details)

Uploaded Python 3

File details

Details for the file pyvcad_rendering-3.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for pyvcad_rendering-3.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ac06ed7fbeea5307457befda4e8c174c17419a9ed58258ff6bd6a7509bb6c292
MD5 7213615f1ce517cbcbf090fcb9384db3
BLAKE2b-256 360125875ca926f22d7e62e5e276fd6e888c06a7a2879e0eff9de586686788a9

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

3.0.2 This release

1 file

3.0.1

1 file

3.0.0

1 file

1.0.8

1 file

1.0.7

1 file

1.0.6

1 file

1.0.5

2 files

1.0.3

2 files

1.0.2

2 files

1.0.1

2 files

1.0.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page