Skip to content

docs: packages/openvaf-py.md code example uses wrong function name and non-existent attributes #142

@github-actions

Description

@github-actions

Problem

docs/packages/openvaf-py.md (lines 25–29) contains a code example that uses an API that doesn't exist:

# Line 25 — wrong function name
module = openvaf_py.compile("resistor.va")

# Lines 28–29 — wrong attribute names
print(module.functions)  # Available functions (init, eval)
print(module.params)     # Model parameters

What's wrong

  1. Wrong function name: The function is openvaf_py.compile_va(), not openvaf_py.compile(). See openvaf_jax/openvaf_py/openvaf_py.pyi line 215. Also, compile_va() returns a list of VaModule objects (one per module in the file), not a single module.

  2. Non-existent attributes: VaModule has no .functions or .params attributes. The actual attributes for inspecting a module are param_names (list of parameter names), param_kinds (list of kinds), nodes (node names), num_residuals, num_jacobian, etc.

Fix

Replace the example with something like:

import openvaf_py

# Compile a Verilog-A model (returns list of modules)
modules = openvaf_py.compile_va("resistor.va")
module = modules[0]

# Get model metadata
print(module.param_names)   # Parameter names
print(module.nodes)         # Node names
print(module.num_residuals) # Number of residual equations

File

docs/packages/openvaf-py.md, lines 24–29

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation issues

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions