::ngspicetclbridgeTop, Main, Index

CommandsTop, Main, Index

abort [::ngspicetclbridge]Top, Main, Index

Sets an internal abort flag and wake any waiters (useful to force waitevent to return). This does not free the instance.

asyncvector [::ngspicetclbridge]Top, Main, Index

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). By addding -info switch, vector metadata is provided, i.e. type of the vector (current, voltage, time, etc), type of the numbers (complex or real), and length of the vector.

Parameters

Description

Example:

$sim initvectors
$sim asyncvector out
# -> {0.0 0.066666... 0.133333... ...}

$sim asyncvector V(9)
# -> {{0.01 0.00} {0.02 0.00} ...}   ;# if complex

Return value

real vectors as a flat list of doubles, complex vectors as a list of {re im} pairs. Error if vector does not exists.

circuit [::ngspicetclbridge]Top, Main, Index

Sends an circuit to Ngspice in form of the list, each element is the lineof the netlist.

Parameters

Description

Example:

set resDivCircuit {
    Resistor divider
    v1 in 0 1
    r1 in out 1e3
    r2 out 0 2e3
    .dc v1 0 5 0.1
    .save all
    .end
}
$sim circuit [split $resDivCircuit \n]
$sim command bg_run

Return value

Ngspice result code

command [::ngspicetclbridge]Top, Main, Index

Sends an arbitrary Ngspice command line (e.g., bg_run, circbyline ..., .save, .tran, .dc). If we provide -capture switch, it returns not only the result code, but also the next message from stdout of Ngspice. Also, if command is send in the moment background thread is starting or stopping, it will be deferred to the time is could be safely sent, and in that case -capture message and command results code are not availaible as a return of command.

Parameters

Description

Example:

$sim command {circbyline v1 in 0 1}
$sim command bg_run

Return value

Ngspice result code, or dictionary with result code and the message

destroy [::ngspicetclbridge]Top, Main, Index

Deletes the instance command. In details:

Description

• Marks the context as destroying
• Wakes any waiters
• Quiesces the ngspice background thread
• Defers and performs full cleanup

eventcounts [::ngspicetclbridge]Top, Main, Index

Gets or reset the cumulative event counters for this simulator instance.

Parameters

Description

Example:

$sim eventcounts
# -> send_char N  send_stat N  controlled_exit N send_data N  send_init_data N  bg_running N

Return value

returns a dict with keys as events names, and counts for each event as a value

getCircuit [::ngspicetclbridge]Top, Main, Index

Gets list with currently loaded circuit (its listing) in the form specified by the switch.

Parameters

Return value

list with listing lines

getCircuitTitle [::ngspicetclbridge]Top, Main, Index

Gets title of the current circuit (first line of circuits netlist).

Parameters

Return value

title

getPlotDate [::ngspicetclbridge]Top, Main, Index

Gets time stamp of current plot generation.

Parameters

Return value

time stamp

getPlotName [::ngspicetclbridge]Top, Main, Index

Gets name of the current plot, i.e. Operating Point, AC Analysis, etc.

Parameters

Return value

name of the plot

getScaleInfo [::ngspicetclbridge]Top, Main, Index

Gets dictionary with information about current scale vector.

Parameters

Return value

dictionary with the information

initvectors [::ngspicetclbridge]Top, Main, Index

Returns held initial vector metadata (built from send_init_data) in a dict. dict with initial vector metadata saved in internal structure

Parameters

Description

Example:

$sim initvectors
# -> out {number 1 real 1} in {number 2 real 1} v-sweep {number 3 real 1}

Warning: accumulation of data do not continues after call bg_run, new metadata replace the old one in the storage.

Return value

Returns held initial vector metadata (built from send_init_data) in a dict. dict with initial vector metadata saved in internal structure

inputpath [::ngspicetclbridge]Top, Main, Index

Returns current path for XSPICE code models if -current switch is provided, or set current path to value provided. current path

Parameters

Return value

Returns current path for XSPICE code models if -current switch is provided, or set current path to value provided. current path

isrunning [::ngspicetclbridge]Top, Main, Index

Calls asynchronously to check if background thread is running.

Return value

1 if thread is running, 0 otherwise.

messages [::ngspicetclbridge]Top, Main, Index

Queues of textual messages captured from Ngspice (stdout/stderr) and bridge status lines.

Parameters

Description

Example:

join [$sim messages] \n
# stdout ******
# stdout ** ngspice-44.x shared library
# ...
# # status[0]: --ready--

Warning: accumulation of messages continues even if you run new circuit or analysis until you explicitly clear the data storage.

Return value

list of messages

new [::ngspicetclbridge]Top, Main, Index

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. Optionally the spinit and/or spiceinit initialization files could be forbidden for loading.

Parameters

Description

Example:

set sim [::ngspicetclbridge::new /usr/local/lib/libngspice.so]

Return value

command name to work with Ngspice instance

plot [::ngspicetclbridge]Top, Main, Index

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

Parameters

Return value

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

readVecsAsync [::ngspicetclbridge]Top, Main, Index

Reads all availible vectors of the current plot asynchronously and return dictionary with vector name as a key, and data as a value. If -info switch is provided, command returns information about each availiable vector.

Parameters

Return value

dictionary

run [::ngspicetclbridge]Top, Main, Index

Runs simulation in background thread, waits for the completion, process event in the queue and returns

Parameters

Return value

vectors [::ngspicetclbridge]Top, Main, Index

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

Parameters

Description

Example:

$sim vectors
# -> v(out) {0.0 0.1 0.2 ...} v(in) {...} v-sweep {...}

$sim vectors -clear
# -> (no result; succeeds)

Return value

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

waitevent [::ngspicetclbridge]Top, Main, Index

Blocks until a named event is observed n number of times (or once), the instance is aborted/destroyed, or the timeout expires (if provided).

Parameters

Description

Return value

dictionary with information about event