Skip to content

docs: api_reference.md missing run_dc_sweep() and DCSweepResult #109

@github-actions

Description

@github-actions

Problem

api_reference.md has no documentation for run_dc_sweep() or DCSweepResult, even though the method is fully implemented and exported.

Confirmed the method exists:

from vajax import CircuitEngine
from vajax.analysis.engine import DCSweepResult
# Signature: (self, source: str, start: float, stop: float, step=None, points=None) -> DCSweepResult

DCSweepResult is also exported from vajax.analysis (in analysis/__init__.py), but not from the top-level vajax package.

Related

Fix Needed

Add a run_dc_sweep() section to docs/api_reference.md documenting:

  • Method signature and all parameters (source, start, stop, step, points)
  • DCSweepResult dataclass fields (sweep_parameter, sweep_values, voltages, currents, num_points)
  • A brief usage example

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