Tcl NgspiceTclBridge package (v0.1)

Index

  • Type the index terms you want to search for in the text input field.
  • Matching terms will be shown incrementally as you type.
  • Press Enter to navigate to the target of the first displayed index entry.
  • Alternatively, Tab to move to the index entry of interest and then press Enter to navigate to that documentation page.
  • To jump to this page from any other documentation page, press browser-specific shortcut modifiers with i. For example, on IE and Edge this would be Alt-i while on Firefox and Chrome Alt-Shift-i. Other browsers and platforms may differ.
  • abort
    abort 
    Sets an internal abort flag and wake any waiters (useful to force waitevent to return). This does not free the instance.
    ::ngspicetclbridge
  • asyncvector
    asyncvector name
    Fetches the current values of a named vector on demand via ngspice ngGet_Vec_Info. Works after the simulation has produced any data (not necessarily the complete vector).
    ::ngspicetclbridge
  • circuit
    circuit list
    Sends an circuit to Ngspice in form of the list, each element is the lineof the netlist.
    ::ngspicetclbridge
  • command
    command string
    Sends an arbitrary Ngspice command line (e.g., bg_run, circbyline ..., .save, .tran, .dc).
    ::ngspicetclbridge
  • destroy
    destroy 
    Deletes the instance command. In details:
    ::ngspicetclbridge
  • eventcounts
    eventcounts ?-clear?
    Gets or reset the cumulative event counters for this simulator instance.
    ::ngspicetclbridge
  • init
    init 
    Initializes the ngspice shared instance and the bridge’s data structures.
    ::ngspicetclbridge
  • initvectors
    initvectors ?-clear?
    Returns held initial vector metadata (built from send_init_data) in a dict. dict with initial vector metadata saved in internal structure
    ::ngspicetclbridge
  • isrunning
    isrunning 
    Calls asynchronously to check if background thread is running.
    ::ngspicetclbridge
  • messages
    messages ?-clear?
    Queues of textual messages captured from Ngspice (stdout/stderr) and bridge status lines.
    ::ngspicetclbridge
  • new
    new path
    Load dynamic library, path should be provided in native form for target OS. Every ::ngspicetclbridge::new returns a command (e.g. ::ngspicetclbridge::s1). The following subcommands operate on that instance.
    ::ngspicetclbridge
  • plot
    plot -all
    plot -vecs name
    Returns current plot name if no arguments provided, names of all plots or all vectors names that belongs to name of the provided plot. current plot, or list of all plots, or list of all vectors
    ::ngspicetclbridge
  • vectors
    vectors ?-clear?
    Returns held synchronously accumulated vector values (built from send_data events) in a dict. dict with vectors values accumulated up to this point in internal structure
    ::ngspicetclbridge
  • waitevent
    waitevent ?args?
    Blocks until a named event is observed, the instance is aborted/destroyed, or the timeout expires (if provided).
    ::ngspicetclbridge