Skip to main content Link Search Menu Expand Document (external link)

JUPYTER

Core package for Jupyter support including kernel and installer abstract classes.

Nicknames

j

Exports

*debug-environment*, *debug-frame*, *debugger*, *html-output*, *kernel*, *markdown-output*, *page-output*, *thread-id*, add-thread, clear, code-is-complete, comm, comm-id, command-line, complete-code, create-comm, debug-abort, debug-activate-breakpoints, debug-breakpoint, debug-breakpoint-data, debug-breakpoint-line, debug-continue, debug-dump-cell, debug-enter-loop, debug-environment, debug-environment-condition, debug-environment-restarts, debug-evaluate, debug-frame, debug-in, debug-initialize, debug-inspect-variables, debug-new-breakpoint, debug-next, debug-object, debug-object-children, debug-object-children-resolve, debug-object-column, debug-object-data, debug-object-environment, debug-object-id, debug-object-line, debug-object-name, debug-object-parent, debug-object-source, debug-object-type, debug-object-value, debug-out, debug-remove-breakpoint, debug-scope, debug-source, debug-source-name, debug-source-path, debug-stop, debug-variable, display, edit, enqueue-input, evaluate-code, execute-result, file, get-comm, gif-file, handling-comm-errors, handling-errors, html, inform, inline-result, inspect-code, install, installer, installer-class, installer-display-name, installer-implementation, installer-kernel-name, installer-language, installer-local, installer-local-systems, installer-path, installer-prefix, installer-resources, installer-systems, javascript, jpeg, jpeg-file, json, json-file, kernel, kernel-debugger-started, kernel-prompt-prefix, kernel-prompt-suffix, latex, make-mime-bundle, make-object, make-offset-match-set, make-substring-match-set, make-uuid, markdown, match-set-add, mime-bundle-data, mime-bundle-metadata, on-comm-close, on-comm-message, on-comm-open, pdf-file, png, png-file, ps-file, quit, remove-debug-object, remove-thread, result, run-kernel, send-comm-close, send-comm-message, send-comm-open, send-debug-event, start, stop, svg, svg-file, system-bundle-installer, system-installer, text, user-image-installer, user-installer, user-thread-p, vega, vega-file, vega-lite,

*debug-environment*

Dynamic Variable

nil

*debug-frame*

Dynamic Variable

nil

*debugger*

Dynamic Variable

t

*html-output*

Dynamic Variable

nil

*kernel*

Dynamic Variable

nil

*markdown-output*

Dynamic Variable

nil

*page-output*

Dynamic Variable

nil

*thread-id*

Dynamic Variable

nil

add-thread

Function

Create a thread queue in the kernel and assign the thread an id number.

(add-thread kernel-instance)

clear

Function

Send clear output message to frontend.

(clear &optional (wait nil))

code-is-complete

Generic Function

Check code for completeness. Kernel implementations should result one of the permitted values of complete, incomplete, unknown or invalid.

(code-is-complete kernel code)

comm

Class

Precedence List

comm, source, standard-object, slot-object, t

Slots
  • sink
    • :initarg :sink
  • comm-id
    • :initarg :comm-id
  • target-name
    • :initarg :target-name
  • kernel
    • :initarg :kernel
Methods
  • comm-kernel — automatically generated reader method

      (comm-kernel (comm comm))
    
  • comm-target-name — automatically generated reader method

      (comm-target-name (comm comm))
    
  • comm-id — automatically generated reader method

      (comm-id (comm comm))
    
  • source-sink — automatically generated writer method

      (setf (source-sink (source source)) new-value)
    
  • source-sink — automatically generated reader method

      (source-sink (source source))
    

comm-id

Generic Function

(comm-id object)

command-line

Generic Function

Get the command line for an installer instance.

(command-line instance)

complete-code

Generic Function

Complete code at cursor-pos. Successful matches should be added to match-set via match-set-add. Errors should be returned as (values ename evalue traceback).

(complete-code kernel match-set code cursor-pos)

create-comm

Generic Function

(create-comm target-name id data metadata buffers)

debug-abort

Generic Function

Abort the current stopped thread.

(debug-abort kernel environment)

debug-activate-breakpoints

Generic Function

Activate a breakpoint.

(debug-activate-breakpoints kernel source breakpoints)

debug-breakpoint

Class

A line oriented breakpoint.

Precedence List

debug-breakpoint, standard-object, slot-object, t

Slots
  • line [integer] — The line number associated with the breakpoint.
    • :initarg :line
  • data — Implementation specific data for the breakpoint
    • :initarg :data
Methods
  • debug-breakpoint-data — Implementation specific data for the breakpoint

      (setf (debug-breakpoint-data (debug-breakpoint debug-breakpoint)) new-value)
    
  • debug-breakpoint-data — Implementation specific data for the breakpoint

      (debug-breakpoint-data (debug-breakpoint debug-breakpoint))
    
  • debug-breakpoint-line — The line number associated with the breakpoint.

      (debug-breakpoint-line (debug-breakpoint debug-breakpoint))
    

debug-breakpoint-data

Generic Function

(debug-breakpoint-data object)

debug-breakpoint-line

Generic Function

(debug-breakpoint-line object)

debug-continue

Generic Function

Continue execution of the stopped thread.

(debug-continue kernel environment &optional restart-number)

debug-dump-cell

Generic Function

Save the code to the provided source-path.

(debug-dump-cell kernel code source-path)

debug-enter-loop

Function

Re-enter the debug loop after a restart which implements a debugger command.

(debug-enter-loop)

debug-environment

Class

A debug environment for a stopped thread.

Precedence List

debug-environment, standard-object, slot-object, t

Slots
  • frames — The frames associated with the environment
    • :initarg :frames
  • objects — The debug-objects created in the environment. The id number is the same as the index in the array.
  • condition — The condition which caused the debugger to be entered.
    • :initarg :condition
  • restarts — Applicable restarts for the environment.
    • :initarg :restarts
Methods
  • debug-environment-restarts — Applicable restarts for the environment.

      (setf (debug-environment-restarts (debug-environment debug-environment))
              new-value)
    
  • debug-environment-restarts — Applicable restarts for the environment.

      (debug-environment-restarts (debug-environment debug-environment))
    
  • debug-environment-condition — The condition which caused the debugger to be entered.

      (setf (debug-environment-condition (debug-environment debug-environment))
              new-value)
    
  • debug-environment-condition — The condition which caused the debugger to be entered.

      (debug-environment-condition (debug-environment debug-environment))
    
  • debug-environment-objects — The debug-objects created in the environment. The id number is the same as the index in the array.

      (debug-environment-objects (debug-environment debug-environment))
    
  • debug-environment-frames — The frames associated with the environment

      (setf (debug-environment-frames (debug-environment debug-environment))
              new-value)
    
  • debug-environment-frames — The frames associated with the environment

      (debug-environment-frames (debug-environment debug-environment))
    

debug-environment-condition

Generic Function

(debug-environment-condition object)

debug-environment-restarts

Generic Function

(debug-environment-restarts object)

debug-evaluate

Generic Function

Evaluate code in the context of a frame

(debug-evaluate kernel environment code frame)

debug-frame

Class

A debugger frame.

Precedence List

debug-frame, debug-object, standard-object, slot-object, t

Slots
  • id [integer] — The id of the object.
    • :initarg :id
  • environment — An environment reference for object. If the object does not have children then it doesn’t need an environment reference.
    • :initarg :environment
  • parent — The parent object
    • :initarg :parent
  • children — Children of the object, i.e. scopes, slots, etc.
  • name [string] — The name of the object.
    • :initarg :name
  • data — Implementation specific data associated with the object.
    • :initarg :data
  • source — The source reference of the frame.
    • :initarg :source
  • line [integer] — A line number of the frame.
    • :initarg :line
  • column [integer] — The column number of the frame.
    • :initarg :column
Methods
  • debug-object-column — The column number of the frame.

      (setf (debug-object-column (debug-frame debug-frame)) new-value)
    
  • debug-object-column — The column number of the frame.

      (debug-object-column (debug-frame debug-frame))
    
  • debug-object-line — A line number of the frame.

      (setf (debug-object-line (debug-frame debug-frame)) new-value)
    
  • debug-object-line — A line number of the frame.

      (debug-object-line (debug-frame debug-frame))
    
  • debug-object-source — The source reference of the frame.

      (setf (debug-object-source (debug-frame debug-frame)) new-value)
    
  • debug-object-source — The source reference of the frame.

      (debug-object-source (debug-frame debug-frame))
    
  • debug-object-children

      (debug-object-children (instance debug-object))
    
  • debug-object-data — Implementation specific data associated with the object.

      (setf (debug-object-data (debug-object debug-object)) new-value)
    
  • debug-object-data — Implementation specific data associated with the object.

      (debug-object-data (debug-object debug-object))
    
  • debug-object-name — The name of the object.

      (setf (debug-object-name (debug-object debug-object)) new-value)
    
  • debug-object-name — The name of the object.

      (debug-object-name (debug-object debug-object))
    
  • debug-object-children — Children of the object, i.e. scopes, slots, etc.

      (setf (debug-object-children (debug-object debug-object)) new-value)
    
  • debug-object-children — Children of the object, i.e. scopes, slots, etc.

      (debug-object-children (debug-object debug-object))
    
  • debug-object-parent — The parent object

      (setf (debug-object-parent (debug-object debug-object)) new-value)
    
  • debug-object-parent — The parent object

      (debug-object-parent (debug-object debug-object))
    
  • debug-object-environment — An environment reference for object. If the object does not have children then it doesn’t need an environment reference.

      (setf (debug-object-environment (debug-object debug-object)) new-value)
    
  • debug-object-environment — An environment reference for object. If the object does not have children then it doesn’t need an environment reference.

      (debug-object-environment (debug-object debug-object))
    
  • debug-object-id — The id of the object.

      (setf (debug-object-id (debug-object debug-object)) new-value)
    
  • debug-object-id — The id of the object.

      (debug-object-id (debug-object debug-object))
    

debug-in

Generic Function

Step into a function on the stopped thread.

(debug-in kernel environment)

debug-initialize

Generic Function

Perform any kernel specific initialization of the debugger and return capabilities.

(debug-initialize kernel)

debug-inspect-variables

Generic Function

Return a list of debug-objects represents the variables in the global scope.

(debug-inspect-variables kernel environment)

debug-new-breakpoint

Generic Function

Create a new breakpoint or return NIL if not possible

(debug-new-breakpoint kernel source line)

debug-next

Generic Function

Step to the next form on the stopped thread.

(debug-next kernel environment)

debug-object

Class

A debug object. Superclass of frames, scopes, variables, etc.

Precedence List

debug-object, standard-object, slot-object, t

Slots
  • id [integer] — The id of the object.
    • :initarg :id
  • environment — An environment reference for object. If the object does not have children then it doesn’t need an environment reference.
    • :initarg :environment
  • parent — The parent object
    • :initarg :parent
  • children — Children of the object, i.e. scopes, slots, etc.
  • name [string] — The name of the object.
    • :initarg :name
  • data — Implementation specific data associated with the object.
    • :initarg :data
Methods
  • debug-object-children

      (debug-object-children (instance debug-object))
    
  • debug-object-data — Implementation specific data associated with the object.

      (setf (debug-object-data (debug-object debug-object)) new-value)
    
  • debug-object-data — Implementation specific data associated with the object.

      (debug-object-data (debug-object debug-object))
    
  • debug-object-name — The name of the object.

      (setf (debug-object-name (debug-object debug-object)) new-value)
    
  • debug-object-name — The name of the object.

      (debug-object-name (debug-object debug-object))
    
  • debug-object-children — Children of the object, i.e. scopes, slots, etc.

      (setf (debug-object-children (debug-object debug-object)) new-value)
    
  • debug-object-children — Children of the object, i.e. scopes, slots, etc.

      (debug-object-children (debug-object debug-object))
    
  • debug-object-parent — The parent object

      (setf (debug-object-parent (debug-object debug-object)) new-value)
    
  • debug-object-parent — The parent object

      (debug-object-parent (debug-object debug-object))
    
  • debug-object-environment — An environment reference for object. If the object does not have children then it doesn’t need an environment reference.

      (setf (debug-object-environment (debug-object debug-object)) new-value)
    
  • debug-object-environment — An environment reference for object. If the object does not have children then it doesn’t need an environment reference.

      (debug-object-environment (debug-object debug-object))
    
  • debug-object-id — The id of the object.

      (setf (debug-object-id (debug-object debug-object)) new-value)
    
  • debug-object-id — The id of the object.

      (debug-object-id (debug-object debug-object))
    

debug-object-children

Generic Function

(debug-object-children object)

debug-object-children-resolve

Generic Function

Return a list of debug-objects for the children of the instance.

(debug-object-children-resolve instance)

debug-object-column

Generic Function

(debug-object-column object)

debug-object-data

Generic Function

(debug-object-data object)

debug-object-environment

Generic Function

(debug-object-environment object)

debug-object-id

Generic Function

(debug-object-id object)

debug-object-line

Generic Function

(debug-object-line object)

debug-object-name

Generic Function

(debug-object-name object)

debug-object-parent

Generic Function

(debug-object-parent object)

debug-object-source

Generic Function

(debug-object-source object)

debug-object-type

Generic Function

(debug-object-type object)

debug-object-value

Generic Function

(debug-object-value object)

debug-out

Generic Function

Step out on the stopped thread.

(debug-out kernel environment)

debug-remove-breakpoint

Generic Function

Remove a specific breakpoint

(debug-remove-breakpoint kernel source breakpoint)

debug-scope

Class

A scope inside a frame.

Precedence List

debug-scope, debug-object, standard-object, slot-object, t

Slots
  • id [integer] — The id of the object.
    • :initarg :id
  • environment — An environment reference for object. If the object does not have children then it doesn’t need an environment reference.
    • :initarg :environment
  • parent — The parent object
    • :initarg :parent
  • children — Children of the object, i.e. scopes, slots, etc.
  • name [string] — The name of the object.
    • :initarg :name
  • data — Implementation specific data associated with the object.
    • :initarg :data
  • presentation-hint [string] — Any presentation hints associated with the scope.
    • :initarg :presentation-hint
Methods
  • debug-presentation-hint — Any presentation hints associated with the scope.

      (debug-presentation-hint (debug-scope debug-scope))
    
  • debug-object-children

      (debug-object-children (instance debug-object))
    
  • debug-object-data — Implementation specific data associated with the object.

      (setf (debug-object-data (debug-object debug-object)) new-value)
    
  • debug-object-data — Implementation specific data associated with the object.

      (debug-object-data (debug-object debug-object))
    
  • debug-object-name — The name of the object.

      (setf (debug-object-name (debug-object debug-object)) new-value)
    
  • debug-object-name — The name of the object.

      (debug-object-name (debug-object debug-object))
    
  • debug-object-children — Children of the object, i.e. scopes, slots, etc.

      (setf (debug-object-children (debug-object debug-object)) new-value)
    
  • debug-object-children — Children of the object, i.e. scopes, slots, etc.

      (debug-object-children (debug-object debug-object))
    
  • debug-object-parent — The parent object

      (setf (debug-object-parent (debug-object debug-object)) new-value)
    
  • debug-object-parent — The parent object

      (debug-object-parent (debug-object debug-object))
    
  • debug-object-environment — An environment reference for object. If the object does not have children then it doesn’t need an environment reference.

      (setf (debug-object-environment (debug-object debug-object)) new-value)
    
  • debug-object-environment — An environment reference for object. If the object does not have children then it doesn’t need an environment reference.

      (debug-object-environment (debug-object debug-object))
    
  • debug-object-id — The id of the object.

      (setf (debug-object-id (debug-object debug-object)) new-value)
    
  • debug-object-id — The id of the object.

      (debug-object-id (debug-object debug-object))
    

debug-source

Class

A source reference in the debugger.

Precedence List

debug-source, standard-object, slot-object, t

Slots
  • name [string] — The name associated with the source.
    • :initarg :name
  • path [(or pathname string)] — The path of the source.
    • :initarg :path
Methods
  • debug-source-path — The path of the source.

      (debug-source-path (debug-source debug-source))
    
  • debug-source-name — The name associated with the source.

      (debug-source-name (debug-source debug-source))
    

debug-source-name

Generic Function

(debug-source-name object)

debug-source-path

Generic Function

(debug-source-path object)

debug-stop

Function

Enter a stopped state on the current thread. This function will dispatch messages received from the CONTROL thread. Resumption of the thread is done through continue restarts so this function will not return.

(debug-stop reason environment)

debug-variable

Class

A debugger variable

Precedence List

debug-variable, debug-object, standard-object, slot-object, t

Slots
  • id [integer] — The id of the object.
    • :initarg :id
  • environment — An environment reference for object. If the object does not have children then it doesn’t need an environment reference.
    • :initarg :environment
  • parent — The parent object
    • :initarg :parent
  • children — Children of the object, i.e. scopes, slots, etc.
  • name [string] — The name of the object.
    • :initarg :name
  • data — Implementation specific data associated with the object.
    • :initarg :data
  • value [string] — A printed representation of the value.
    • :initarg :value
  • type [string] — The type associated with the variable
    • :initarg :type
Methods
  • debug-object-type — The type associated with the variable

      (setf (debug-object-type (debug-variable debug-variable)) new-value)
    
  • debug-object-type — The type associated with the variable

      (debug-object-type (debug-variable debug-variable))
    
  • debug-object-value — A printed representation of the value.

      (setf (debug-object-value (debug-variable debug-variable)) new-value)
    
  • debug-object-value — A printed representation of the value.

      (debug-object-value (debug-variable debug-variable))
    
  • debug-object-children

      (debug-object-children (instance debug-object))
    
  • debug-object-data — Implementation specific data associated with the object.

      (setf (debug-object-data (debug-object debug-object)) new-value)
    
  • debug-object-data — Implementation specific data associated with the object.

      (debug-object-data (debug-object debug-object))
    
  • debug-object-name — The name of the object.

      (setf (debug-object-name (debug-object debug-object)) new-value)
    
  • debug-object-name — The name of the object.

      (debug-object-name (debug-object debug-object))
    
  • debug-object-children — Children of the object, i.e. scopes, slots, etc.

      (setf (debug-object-children (debug-object debug-object)) new-value)
    
  • debug-object-children — Children of the object, i.e. scopes, slots, etc.

      (debug-object-children (debug-object debug-object))
    
  • debug-object-parent — The parent object

      (setf (debug-object-parent (debug-object debug-object)) new-value)
    
  • debug-object-parent — The parent object

      (debug-object-parent (debug-object debug-object))
    
  • debug-object-environment — An environment reference for object. If the object does not have children then it doesn’t need an environment reference.

      (setf (debug-object-environment (debug-object debug-object)) new-value)
    
  • debug-object-environment — An environment reference for object. If the object does not have children then it doesn’t need an environment reference.

      (debug-object-environment (debug-object debug-object))
    
  • debug-object-id — The id of the object.

      (setf (debug-object-id (debug-object debug-object)) new-value)
    
  • debug-object-id — The id of the object.

      (debug-object-id (debug-object debug-object))
    

display

Function

Send a result as mime bundle display data. result must implement the mime-bundle-data method and optionally mime-bundle-metadata. If an id is specified then future calls with the same id and update is t.

(display result &key id update)

edit

Function

(edit path &optional (line-number 0))

enqueue-input

Function

Add code to input queue.

(enqueue-input kernel code)

evaluate-code

Generic Function

Evaluate code along with paged output. Evaluation results should be sent with execute-result. Errors should be returned as (values ename evalue traceback)

(evaluate-code kernel code &optional source-path breakpoints)

execute-result

Function

Send a result as mime bundle execution result. result must implement the mime-bundle-data method and optionally mime-bundle-metadata.

(execute-result result)

file

Function

Create a result based on a file path. The mime type will automatically be determined from the file extension.

(file path &key display update id)

get-comm

Function

(get-comm id)

gif-file

Function

Create a GIF image result based on a file path.

(gif-file path &key display update id)

handling-comm-errors

Macro

Macro for catching any conditions during comm messages.

(handling-comm-errors
  &body
  body)

handling-errors

Macro

Macro for catching any conditions during code evaluation.

(handling-errors
  &body
  body)

html

Function

Create a HTML result based on an inline value.

(html value &key display update id)

inform

Function

(inform level src format-control &rest format-arguments)

inline-result

Function

Create a result based on an inline value.

(inline-result value mime-type &key display update id)

inspect-code

Generic Function

Inspect code at cursor-pos with detail-level. Successful inspection should return a single result that implements mime-bundle-data and optionally mime-bundle-metadata. Errors should be returned as (values nil ename evalue traceback).

(inspect-code kernel code cursor-pos detail-level)

install

Generic Function

Install a kernel based on an installer instance.

(install instance)

installer

Class

Base installer class.

Precedence List

installer, standard-object, slot-object, t

Slots
  • class — Class that implements the kernel. Used by image based installations.
    • :initarg :class
  • debugger — Whether or not the kernel supports debugging.
    • :initarg :debugger
  • display-name — Name of the kernel displayed to the user.
    • :initarg :display-name
  • implementation — Path to specific binary used by the kernel.
    • :initarg :implementation
  • kernel-name — Name of the kernel.
    • :initarg :kernel-name
  • language — Language that the kernel supports.
    • :initarg :language
  • local — Is the installation a local or packaged installation?
    • :initarg :local
  • local-systems — List of systems to package into local-projects.
    • :initarg :local-systems
  • prefix — Directory to put installed files into. Used by packaging system, should be nil otherwise.
    • :initarg :prefix
  • resources — List of paths of resource files such as icons.
    • :initarg :resources
  • root — The root directory under which the Jupyter folder is found. If nil then it will be determined automatically.
    • :initarg :root
  • systems — List of systems to bundle for system installs.
    • :initarg :systems
Methods
  • install — Do common installation tasks before the specific ones association with this instance.

      (install (instance installer))
    
  • installer-systems — List of systems to bundle for system installs.

      (setf (installer-systems (installer installer)) new-value)
    
  • installer-systems — List of systems to bundle for system installs.

      (installer-systems (installer installer))
    
  • installer-root — The root directory under which the Jupyter folder is found. If nil then it will be determined automatically.

      (setf (installer-root (installer installer)) new-value)
    
  • installer-root — The root directory under which the Jupyter folder is found. If nil then it will be determined automatically.

      (installer-root (installer installer))
    
  • installer-resources — List of paths of resource files such as icons.

      (setf (installer-resources (installer installer)) new-value)
    
  • installer-resources — List of paths of resource files such as icons.

      (installer-resources (installer installer))
    
  • installer-prefix — Directory to put installed files into. Used by packaging system, should be nil otherwise.

      (setf (installer-prefix (installer installer)) new-value)
    
  • installer-prefix — Directory to put installed files into. Used by packaging system, should be nil otherwise.

      (installer-prefix (installer installer))
    
  • installer-local-systems — List of systems to package into local-projects.

      (setf (installer-local-systems (installer installer)) new-value)
    
  • installer-local-systems — List of systems to package into local-projects.

      (installer-local-systems (installer installer))
    
  • installer-local — Is the installation a local or packaged installation?

      (setf (installer-local (installer installer)) new-value)
    
  • installer-local — Is the installation a local or packaged installation?

      (installer-local (installer installer))
    
  • installer-language — Language that the kernel supports.

      (setf (installer-language (installer installer)) new-value)
    
  • installer-language — Language that the kernel supports.

      (installer-language (installer installer))
    
  • installer-kernel-name — Name of the kernel.

      (setf (installer-kernel-name (installer installer)) new-value)
    
  • installer-kernel-name — Name of the kernel.

      (installer-kernel-name (installer installer))
    
  • installer-implementation — Path to specific binary used by the kernel.

      (setf (installer-implementation (installer installer)) new-value)
    
  • installer-implementation — Path to specific binary used by the kernel.

      (installer-implementation (installer installer))
    
  • installer-display-name — Name of the kernel displayed to the user.

      (setf (installer-display-name (installer installer)) new-value)
    
  • installer-display-name — Name of the kernel displayed to the user.

      (installer-display-name (installer installer))
    
  • installer-debugger — Whether or not the kernel supports debugging.

      (setf (installer-debugger (installer installer)) new-value)
    
  • installer-debugger — Whether or not the kernel supports debugging.

      (installer-debugger (installer installer))
    
  • installer-class — Class that implements the kernel. Used by image based installations.

      (setf (installer-class (installer installer)) new-value)
    
  • installer-class — Class that implements the kernel. Used by image based installations.

      (installer-class (installer installer))
    

installer-class

Generic Function

(installer-class object)

installer-display-name

Generic Function

(installer-display-name object)

installer-implementation

Generic Function

(installer-implementation object)

installer-kernel-name

Generic Function

(installer-kernel-name object)

installer-language

Generic Function

(installer-language object)

installer-local

Generic Function

(installer-local object)

installer-local-systems

Generic Function

(installer-local-systems object)

installer-path

Function

Resolve each of the path parts then combine all into a single path using merge-pathnames.

(installer-path instance &rest parts)

installer-prefix

Generic Function

(installer-prefix object)

installer-resources

Generic Function

(installer-resources object)

installer-systems

Generic Function

(installer-systems object)

javascript

Function

Create a JavaScript text result based on an inline value.

(javascript value &key display update id)

jpeg

Function

Create a JPEG image result based on an inline value.

(jpeg value &key display update id)

jpeg-file

Function

Create a JPEG image result based on a file path.

(jpeg-file path &key display update id)

json

Function

Create a plain text result based on an inline value.

(json value &key display update id expanded)

json-file

Function

Create a JSON result based on a file path.

(json-file path &key display update id expanded)

kernel

Class

Kernel state representation.

Precedence List

kernel, source, standard-object, slot-object, t

Slots
  • sink
    • :initarg :sink
  • name — Kernel name. Used as a unique identifier in kernel description.
    • :initarg :name
  • version — Kernel version.
    • :initarg :version
  • banner — Banner text used to describe kernel. Used in kernel_info_reply messages.
    • :initarg :banner
  • language-name — Display name of implementation language. Used in kernel_info_reply messages.
    • :initarg :language-name
  • language-version — Version of implementation language. Used in kernel_info_reply messages.
    • :initarg :language-version
  • mime-type — Default MIME type for source files. Used in kernel_info_reply messages.
    • :initarg :mime-type
  • file-extension — Default file extension for source files. Used in kernel_info_reply messages.
    • :initarg :file-extension
  • pygments-lexer — Name of Pygments lexer for source files. Used in kernel_info_reply messages.
    • :initarg :pygments-lexer
  • codemirror-mode — CodeMirror mode for source files. Used in kernel_info_reply messages.
    • :initarg :codemirror-mode
  • help-links — An association list of help links. The car is the description and the cdr is URL. Used in kernel_info_reply messages.
    • :initarg :help-links
  • package — The package in which evaluate-code, code-is-complete and others are called.
    • :initarg :package
  • readtable — The readtable used bu evaluate-code, code-is-complete and others.
    • :initarg :readtable
  • connection-file — Pathname of connection file.
    • :initarg :connection-file
  • transport [string] — Transport protocol from connection file.
  • ip [string] — IP address from connection file.
  • shell-port [fixnum] — SHELL port from connection file.
  • stdin-port [fixnum] — STDIN port from connection file.
  • iopub-port [fixnum] — IOPUB port from connection file.
  • control-port [fixnum] — CONTROL port from connection file.
  • hb-port [fixnum] — HB port from connection file.
  • signature-scheme [string] — Signature scheme from connection file.
  • key — Signing key from connection file.
  • prompt-prefix — String prefix using in standard-output to indicate the start of prompt.
    • :initarg :prompt-prefix
  • prompt-suffix — String suffix using in standard-output to indicate the end of prompt.
    • :initarg :prompt-suffix
  • ctx — pzmq ctx handle.
  • mac — Message authentification.
  • hb — Heartbeat channel.
  • shell — SHELL channel.
  • stdin — STDIN channel.
  • control — CONTROL channel.
  • iopub — IOPUB channel.
  • session — Session identifier.
  • input-queue — Input queue used to feed values into execute_result payloads.
    • :initarg :input-queue
  • history — Kernel history manager.
  • execution-count — Kernel execution count.
  • comms — Currently open comms.
  • control-thread — Control thread
    • :initarg :control-thread
  • shell-thread — Shell thread
  • html-output — HTML display output stream
  • markdown-output — Markdown display output stream
  • error-output — Error output stream
  • standard-output — Standard output stream
  • standard-input — Standard input stream
  • tmp-file-prefix — Prefix for temporary debugger files
  • tmp-file-suffix — Suffix for temporary debugger files
  • hash-seed — Hash seed for temporary debugger files
  • breakpoints — Currently set breakpoints.
  • debugger — Whether the debugger is supported
    • :initarg :debugger
  • debugger-started — Whether the debugger has been started
  • threads
Methods
  • stop

      (stop (k kernel))
    
  • start

      (start (k kernel))
    
  • kernel-threads — automatically generated reader method

      (kernel-threads (kernel kernel))
    
  • kernel-debugger-started — Whether the debugger has been started

      (setf (kernel-debugger-started (kernel kernel)) new-value)
    
  • kernel-debugger-started — Whether the debugger has been started

      (kernel-debugger-started (kernel kernel))
    
  • kernel-debugger — Whether the debugger is supported

      (setf (kernel-debugger (kernel kernel)) new-value)
    
  • kernel-debugger — Whether the debugger is supported

      (kernel-debugger (kernel kernel))
    
  • kernel-breakpoints — Currently set breakpoints.

      (setf (kernel-breakpoints (kernel kernel)) new-value)
    
  • kernel-breakpoints — Currently set breakpoints.

      (kernel-breakpoints (kernel kernel))
    
  • kernel-hash-seed — Hash seed for temporary debugger files

      (setf (kernel-hash-seed (kernel kernel)) new-value)
    
  • kernel-hash-seed — Hash seed for temporary debugger files

      (kernel-hash-seed (kernel kernel))
    
  • kernel-tmp-file-suffix — Suffix for temporary debugger files

      (setf (kernel-tmp-file-suffix (kernel kernel)) new-value)
    
  • kernel-tmp-file-suffix — Suffix for temporary debugger files

      (kernel-tmp-file-suffix (kernel kernel))
    
  • kernel-tmp-file-prefix — Prefix for temporary debugger files

      (setf (kernel-tmp-file-prefix (kernel kernel)) new-value)
    
  • kernel-tmp-file-prefix — Prefix for temporary debugger files

      (kernel-tmp-file-prefix (kernel kernel))
    
  • kernel-standard-input — Standard input stream

      (setf (kernel-standard-input (kernel kernel)) new-value)
    
  • kernel-standard-input — Standard input stream

      (kernel-standard-input (kernel kernel))
    
  • kernel-standard-output — Standard output stream

      (setf (kernel-standard-output (kernel kernel)) new-value)
    
  • kernel-standard-output — Standard output stream

      (kernel-standard-output (kernel kernel))
    
  • kernel-error-output — Error output stream

      (setf (kernel-error-output (kernel kernel)) new-value)
    
  • kernel-error-output — Error output stream

      (kernel-error-output (kernel kernel))
    
  • kernel-markdown-output — Markdown display output stream

      (kernel-markdown-output (kernel kernel))
    
  • kernel-html-output — HTML display output stream

      (kernel-html-output (kernel kernel))
    
  • kernel-shell-thread — Shell thread

      (setf (kernel-shell-thread (kernel kernel)) new-value)
    
  • kernel-shell-thread — Shell thread

      (kernel-shell-thread (kernel kernel))
    
  • kernel-control-thread — Control thread

      (setf (kernel-control-thread (kernel kernel)) new-value)
    
  • kernel-control-thread — Control thread

      (kernel-control-thread (kernel kernel))
    
  • kernel-comms — Currently open comms.

      (kernel-comms (kernel kernel))
    
  • kernel-execution-count — Kernel execution count.

      (setf (kernel-execution-count (kernel kernel)) new-value)
    
  • kernel-execution-count — Kernel execution count.

      (kernel-execution-count (kernel kernel))
    
  • kernel-history — Kernel history manager.

      (setf (kernel-history (kernel kernel)) new-value)
    
  • kernel-history — Kernel history manager.

      (kernel-history (kernel kernel))
    
  • kernel-input-queue — Input queue used to feed values into execute_result payloads.

      (kernel-input-queue (kernel kernel))
    
  • kernel-session — Session identifier.

      (setf (kernel-session (kernel kernel)) new-value)
    
  • kernel-session — Session identifier.

      (kernel-session (kernel kernel))
    
  • kernel-iopub — IOPUB channel.

      (setf (kernel-iopub (kernel kernel)) new-value)
    
  • kernel-iopub — IOPUB channel.

      (kernel-iopub (kernel kernel))
    
  • kernel-control — CONTROL channel.

      (setf (kernel-control (kernel kernel)) new-value)
    
  • kernel-control — CONTROL channel.

      (kernel-control (kernel kernel))
    
  • kernel-stdin — STDIN channel.

      (setf (kernel-stdin (kernel kernel)) new-value)
    
  • kernel-stdin — STDIN channel.

      (kernel-stdin (kernel kernel))
    
  • kernel-shell — SHELL channel.

      (setf (kernel-shell (kernel kernel)) new-value)
    
  • kernel-shell — SHELL channel.

      (kernel-shell (kernel kernel))
    
  • kernel-hb — Heartbeat channel.

      (setf (kernel-hb (kernel kernel)) new-value)
    
  • kernel-hb — Heartbeat channel.

      (kernel-hb (kernel kernel))
    
  • kernel-mac — Message authentification.

      (setf (kernel-mac (kernel kernel)) new-value)
    
  • kernel-mac — Message authentification.

      (kernel-mac (kernel kernel))
    
  • kernel-ctx — pzmq ctx handle.

      (setf (kernel-ctx (kernel kernel)) new-value)
    
  • kernel-ctx — pzmq ctx handle.

      (kernel-ctx (kernel kernel))
    
  • kernel-prompt-suffix — String suffix using in standard-output to indicate the end of prompt.

      (kernel-prompt-suffix (kernel kernel))
    
  • kernel-prompt-prefix — String prefix using in standard-output to indicate the start of prompt.

      (kernel-prompt-prefix (kernel kernel))
    
  • kernel-key — Signing key from connection file.

      (setf (kernel-key (kernel kernel)) new-value)
    
  • kernel-key — Signing key from connection file.

      (kernel-key (kernel kernel))
    
  • kernel-signature-scheme — Signature scheme from connection file.

      (setf (kernel-signature-scheme (kernel kernel)) new-value)
    
  • kernel-signature-scheme — Signature scheme from connection file.

      (kernel-signature-scheme (kernel kernel))
    
  • kernel-hb-port — HB port from connection file.

      (setf (kernel-hb-port (kernel kernel)) new-value)
    
  • kernel-hb-port — HB port from connection file.

      (kernel-hb-port (kernel kernel))
    
  • kernel-control-port — CONTROL port from connection file.

      (setf (kernel-control-port (kernel kernel)) new-value)
    
  • kernel-control-port — CONTROL port from connection file.

      (kernel-control-port (kernel kernel))
    
  • kernel-iopub-port — IOPUB port from connection file.

      (setf (kernel-iopub-port (kernel kernel)) new-value)
    
  • kernel-iopub-port — IOPUB port from connection file.

      (kernel-iopub-port (kernel kernel))
    
  • kernel-stdin-port — STDIN port from connection file.

      (setf (kernel-stdin-port (kernel kernel)) new-value)
    
  • kernel-stdin-port — STDIN port from connection file.

      (kernel-stdin-port (kernel kernel))
    
  • kernel-shell-port — SHELL port from connection file.

      (setf (kernel-shell-port (kernel kernel)) new-value)
    
  • kernel-shell-port — SHELL port from connection file.

      (kernel-shell-port (kernel kernel))
    
  • kernel-ip — IP address from connection file.

      (setf (kernel-ip (kernel kernel)) new-value)
    
  • kernel-ip — IP address from connection file.

      (kernel-ip (kernel kernel))
    
  • kernel-transport — Transport protocol from connection file.

      (setf (kernel-transport (kernel kernel)) new-value)
    
  • kernel-transport — Transport protocol from connection file.

      (kernel-transport (kernel kernel))
    
  • kernel-connection-file — Pathname of connection file.

      (kernel-connection-file (kernel kernel))
    
  • kernel-readtable — The readtable used bu evaluate-code, code-is-complete and others.

      (setf (kernel-readtable (kernel kernel)) new-value)
    
  • kernel-readtable — The readtable used bu evaluate-code, code-is-complete and others.

      (kernel-readtable (kernel kernel))
    
  • kernel-package — The package in which evaluate-code, code-is-complete and others are called.

      (setf (kernel-package (kernel kernel)) new-value)
    
  • kernel-package — The package in which evaluate-code, code-is-complete and others are called.

      (kernel-package (kernel kernel))
    
  • kernel-help-links — An association list of help links. The car is the description and the cdr is URL. Used in kernel_info_reply messages.

      (kernel-help-links (kernel kernel))
    
  • kernel-codemirror-mode — CodeMirror mode for source files. Used in kernel_info_reply messages.

      (kernel-codemirror-mode (kernel kernel))
    
  • kernel-pygments-lexer — Name of Pygments lexer for source files. Used in kernel_info_reply messages.

      (kernel-pygments-lexer (kernel kernel))
    
  • kernel-file-extension — Default file extension for source files. Used in kernel_info_reply messages.

      (kernel-file-extension (kernel kernel))
    
  • kernel-mime-type — Default MIME type for source files. Used in kernel_info_reply messages.

      (kernel-mime-type (kernel kernel))
    
  • kernel-language-version — Version of implementation language. Used in kernel_info_reply messages.

      (kernel-language-version (kernel kernel))
    
  • kernel-language-name — Display name of implementation language. Used in kernel_info_reply messages.

      (kernel-language-name (kernel kernel))
    
  • kernel-banner — Banner text used to describe kernel. Used in kernel_info_reply messages.

      (kernel-banner (kernel kernel))
    
  • kernel-version — Kernel version.

      (kernel-version (kernel kernel))
    
  • kernel-name — Kernel name. Used as a unique identifier in kernel description.

      (kernel-name (kernel kernel))
    
  • source-sink — automatically generated writer method

      (setf (source-sink (source source)) new-value)
    
  • source-sink — automatically generated reader method

      (source-sink (source source))
    

kernel-debugger-started

Generic Function

(kernel-debugger-started object)

kernel-prompt-prefix

Generic Function

(kernel-prompt-prefix object)

kernel-prompt-suffix

Generic Function

(kernel-prompt-suffix object)

latex

Function

Create a LaTeX result based on an inline value.

(latex value &key display update id)

make-mime-bundle

Function

(make-mime-bundle data &optional metadata)

make-object

Function

Create a hash table based on args (in plist format) and a test of equal.

(make-object &rest args)

make-offset-match-set

Function

(make-offset-match-set &key ((parent parent) nil) ((offset offset) nil))

make-substring-match-set

Function

(make-substring-match-set &key ((parent parent) nil) ((start start) nil)
                          ((end end) nil))

make-uuid

Function

(make-uuid &optional as-bytes)

markdown

Function

Create a Markdown result based on an inline value.

(markdown value &key display update id)

match-set-add

Generic Function

(match-set-add instance text start end &key type)

mime-bundle-data

Generic Function

Return a JSON object with keys that mime types and the values are a rendering of value in that mime type.

(mime-bundle-data value)

mime-bundle-metadata

Generic Function

Return metadata specific to value.

(mime-bundle-metadata value)

on-comm-close

Generic Function

(on-comm-close comm data metadata buffers)

on-comm-message

Generic Function

(on-comm-message comm data metadata buffers)

on-comm-open

Generic Function

(on-comm-open comm data metadata buffers)

pdf-file

Function

Create a PDF result based on a file path.

(pdf-file path &key display update id)

png

Function

Create a PNG image result based on an inline value.

(png value &key display update id)

png-file

Function

Create a PNG image result based on a file path.

(png-file path &key display update id)

ps-file

Function

Create a PostScript result based on a file path.

(ps-file path &key display update id)

quit

Function

(quit &optional keep-kernel)

remove-debug-object

remove-thread

Function

Remove the thread queue and reset the thread id number.

(remove-thread kernel-instance &optional (thread-id *thread-id*))

result

run-kernel

Function

Run a kernel based on a kernel class and a connection file.

(run-kernel kernel-class &optional
            (connection-file (first (command-line-arguments))))

send-comm-close

Function

(send-comm-close comm &optional data metadata buffers)

send-comm-message

Function

(send-comm-message comm &optional data metadata buffers)

send-comm-open

Function

(send-comm-open comm &optional data metadata buffers)

send-debug-event

Function

(send-debug-event event &optional body &aux (iopub (kernel-iopub *kernel*)))

start

Generic Function

Start the resource.

(start ch)

stop

Generic Function

Stop the resource.

(stop ch)

svg

Function

Create a SVG result based on an inline value.

(svg value &key display update id)

svg-file

Function

Create a SVG result based on a file path.

(svg-file path &key display update id)

system-bundle-installer

Class

System bundle installer class.

Precedence List

system-bundle-installer, system-installer, installer, standard-object, slot-object, t

Slots
  • class — Class that implements the kernel. Used by image based installations.
    • :initarg :class
  • debugger — Whether or not the kernel supports debugging.
    • :initarg :debugger
  • display-name — Name of the kernel displayed to the user.
    • :initarg :display-name
  • implementation — Path to specific binary used by the kernel.
    • :initarg :implementation
  • kernel-name — Name of the kernel.
    • :initarg :kernel-name
  • language — Language that the kernel supports.
    • :initarg :language
  • local — Is the installation a local or packaged installation?
    • :initarg :local
  • local-systems — List of systems to package into local-projects.
    • :initarg :local-systems
  • prefix — Directory to put installed files into. Used by packaging system, should be nil otherwise.
    • :initarg :prefix
  • resources — List of paths of resource files such as icons.
    • :initarg :resources
  • root — The root directory under which the Jupyter folder is found. If nil then it will be determined automatically.
    • :initarg :root
  • systems — List of systems to bundle for system installs.
    • :initarg :systems
Methods
  • install — Install system bundle kernel.

      (install (instance system-bundle-installer))
    
  • install — Install system kernel.

      (install (instance system-installer))
    
  • installer-path-part — Get the root directory for a system installation.

      (installer-path-part (instance system-installer) (type (eql root)))
    
  • install — Do common installation tasks before the specific ones association with this instance.

      (install (instance installer))
    
  • installer-systems — List of systems to bundle for system installs.

      (setf (installer-systems (installer installer)) new-value)
    
  • installer-systems — List of systems to bundle for system installs.

      (installer-systems (installer installer))
    
  • installer-root — The root directory under which the Jupyter folder is found. If nil then it will be determined automatically.

      (setf (installer-root (installer installer)) new-value)
    
  • installer-root — The root directory under which the Jupyter folder is found. If nil then it will be determined automatically.

      (installer-root (installer installer))
    
  • installer-resources — List of paths of resource files such as icons.

      (setf (installer-resources (installer installer)) new-value)
    
  • installer-resources — List of paths of resource files such as icons.

      (installer-resources (installer installer))
    
  • installer-prefix — Directory to put installed files into. Used by packaging system, should be nil otherwise.

      (setf (installer-prefix (installer installer)) new-value)
    
  • installer-prefix — Directory to put installed files into. Used by packaging system, should be nil otherwise.

      (installer-prefix (installer installer))
    
  • installer-local-systems — List of systems to package into local-projects.

      (setf (installer-local-systems (installer installer)) new-value)
    
  • installer-local-systems — List of systems to package into local-projects.

      (installer-local-systems (installer installer))
    
  • installer-local — Is the installation a local or packaged installation?

      (setf (installer-local (installer installer)) new-value)
    
  • installer-local — Is the installation a local or packaged installation?

      (installer-local (installer installer))
    
  • installer-language — Language that the kernel supports.

      (setf (installer-language (installer installer)) new-value)
    
  • installer-language — Language that the kernel supports.

      (installer-language (installer installer))
    
  • installer-kernel-name — Name of the kernel.

      (setf (installer-kernel-name (installer installer)) new-value)
    
  • installer-kernel-name — Name of the kernel.

      (installer-kernel-name (installer installer))
    
  • installer-implementation — Path to specific binary used by the kernel.

      (setf (installer-implementation (installer installer)) new-value)
    
  • installer-implementation — Path to specific binary used by the kernel.

      (installer-implementation (installer installer))
    
  • installer-display-name — Name of the kernel displayed to the user.

      (setf (installer-display-name (installer installer)) new-value)
    
  • installer-display-name — Name of the kernel displayed to the user.

      (installer-display-name (installer installer))
    
  • installer-debugger — Whether or not the kernel supports debugging.

      (setf (installer-debugger (installer installer)) new-value)
    
  • installer-debugger — Whether or not the kernel supports debugging.

      (installer-debugger (installer installer))
    
  • installer-class — Class that implements the kernel. Used by image based installations.

      (setf (installer-class (installer installer)) new-value)
    
  • installer-class — Class that implements the kernel. Used by image based installations.

      (installer-class (installer installer))
    

system-installer

Class

System installer class.

Precedence List

system-installer, installer, standard-object, slot-object, t

Slots
  • class — Class that implements the kernel. Used by image based installations.
    • :initarg :class
  • debugger — Whether or not the kernel supports debugging.
    • :initarg :debugger
  • display-name — Name of the kernel displayed to the user.
    • :initarg :display-name
  • implementation — Path to specific binary used by the kernel.
    • :initarg :implementation
  • kernel-name — Name of the kernel.
    • :initarg :kernel-name
  • language — Language that the kernel supports.
    • :initarg :language
  • local — Is the installation a local or packaged installation?
    • :initarg :local
  • local-systems — List of systems to package into local-projects.
    • :initarg :local-systems
  • prefix — Directory to put installed files into. Used by packaging system, should be nil otherwise.
    • :initarg :prefix
  • resources — List of paths of resource files such as icons.
    • :initarg :resources
  • root — The root directory under which the Jupyter folder is found. If nil then it will be determined automatically.
    • :initarg :root
  • systems — List of systems to bundle for system installs.
    • :initarg :systems
Methods
  • install — Install system kernel.

      (install (instance system-installer))
    
  • installer-path-part — Get the root directory for a system installation.

      (installer-path-part (instance system-installer) (type (eql root)))
    
  • install — Do common installation tasks before the specific ones association with this instance.

      (install (instance installer))
    
  • installer-systems — List of systems to bundle for system installs.

      (setf (installer-systems (installer installer)) new-value)
    
  • installer-systems — List of systems to bundle for system installs.

      (installer-systems (installer installer))
    
  • installer-root — The root directory under which the Jupyter folder is found. If nil then it will be determined automatically.

      (setf (installer-root (installer installer)) new-value)
    
  • installer-root — The root directory under which the Jupyter folder is found. If nil then it will be determined automatically.

      (installer-root (installer installer))
    
  • installer-resources — List of paths of resource files such as icons.

      (setf (installer-resources (installer installer)) new-value)
    
  • installer-resources — List of paths of resource files such as icons.

      (installer-resources (installer installer))
    
  • installer-prefix — Directory to put installed files into. Used by packaging system, should be nil otherwise.

      (setf (installer-prefix (installer installer)) new-value)
    
  • installer-prefix — Directory to put installed files into. Used by packaging system, should be nil otherwise.

      (installer-prefix (installer installer))
    
  • installer-local-systems — List of systems to package into local-projects.

      (setf (installer-local-systems (installer installer)) new-value)
    
  • installer-local-systems — List of systems to package into local-projects.

      (installer-local-systems (installer installer))
    
  • installer-local — Is the installation a local or packaged installation?

      (setf (installer-local (installer installer)) new-value)
    
  • installer-local — Is the installation a local or packaged installation?

      (installer-local (installer installer))
    
  • installer-language — Language that the kernel supports.

      (setf (installer-language (installer installer)) new-value)
    
  • installer-language — Language that the kernel supports.

      (installer-language (installer installer))
    
  • installer-kernel-name — Name of the kernel.

      (setf (installer-kernel-name (installer installer)) new-value)
    
  • installer-kernel-name — Name of the kernel.

      (installer-kernel-name (installer installer))
    
  • installer-implementation — Path to specific binary used by the kernel.

      (setf (installer-implementation (installer installer)) new-value)
    
  • installer-implementation — Path to specific binary used by the kernel.

      (installer-implementation (installer installer))
    
  • installer-display-name — Name of the kernel displayed to the user.

      (setf (installer-display-name (installer installer)) new-value)
    
  • installer-display-name — Name of the kernel displayed to the user.

      (installer-display-name (installer installer))
    
  • installer-debugger — Whether or not the kernel supports debugging.

      (setf (installer-debugger (installer installer)) new-value)
    
  • installer-debugger — Whether or not the kernel supports debugging.

      (installer-debugger (installer installer))
    
  • installer-class — Class that implements the kernel. Used by image based installations.

      (setf (installer-class (installer installer)) new-value)
    
  • installer-class — Class that implements the kernel. Used by image based installations.

      (installer-class (installer installer))
    

text

Function

Create a plain text result based on an inline value.

(text value &key display update id)

user-image-installer

Class

User image installer class.

Precedence List

user-image-installer, user-installer, installer, standard-object, slot-object, t

Slots
  • class — Class that implements the kernel. Used by image based installations.
    • :initarg :class
  • debugger — Whether or not the kernel supports debugging.
    • :initarg :debugger
  • display-name — Name of the kernel displayed to the user.
    • :initarg :display-name
  • implementation — Path to specific binary used by the kernel.
    • :initarg :implementation
  • kernel-name — Name of the kernel.
    • :initarg :kernel-name
  • language — Language that the kernel supports.
    • :initarg :language
  • local — Is the installation a local or packaged installation?
    • :initarg :local
  • local-systems — List of systems to package into local-projects.
    • :initarg :local-systems
  • prefix — Directory to put installed files into. Used by packaging system, should be nil otherwise.
    • :initarg :prefix
  • resources — List of paths of resource files such as icons.
    • :initarg :resources
  • root — The root directory under which the Jupyter folder is found. If nil then it will be determined automatically.
    • :initarg :root
  • systems — List of systems to bundle for system installs.
    • :initarg :systems
Methods
  • install — Create an image for the user image based kernels.

      (install (instance user-image-installer))
    
  • command-line — Get the command for a user image installer.

      (command-line (instance user-image-installer))
    
  • install — Install user kernel.

      (install (instance user-installer))
    
  • installer-path-part — Get the root directory for a user installation

      (installer-path-part (instance user-installer) (type (eql root)))
    
  • install — Do common installation tasks before the specific ones association with this instance.

      (install (instance installer))
    
  • installer-systems — List of systems to bundle for system installs.

      (setf (installer-systems (installer installer)) new-value)
    
  • installer-systems — List of systems to bundle for system installs.

      (installer-systems (installer installer))
    
  • installer-root — The root directory under which the Jupyter folder is found. If nil then it will be determined automatically.

      (setf (installer-root (installer installer)) new-value)
    
  • installer-root — The root directory under which the Jupyter folder is found. If nil then it will be determined automatically.

      (installer-root (installer installer))
    
  • installer-resources — List of paths of resource files such as icons.

      (setf (installer-resources (installer installer)) new-value)
    
  • installer-resources — List of paths of resource files such as icons.

      (installer-resources (installer installer))
    
  • installer-prefix — Directory to put installed files into. Used by packaging system, should be nil otherwise.

      (setf (installer-prefix (installer installer)) new-value)
    
  • installer-prefix — Directory to put installed files into. Used by packaging system, should be nil otherwise.

      (installer-prefix (installer installer))
    
  • installer-local-systems — List of systems to package into local-projects.

      (setf (installer-local-systems (installer installer)) new-value)
    
  • installer-local-systems — List of systems to package into local-projects.

      (installer-local-systems (installer installer))
    
  • installer-local — Is the installation a local or packaged installation?

      (setf (installer-local (installer installer)) new-value)
    
  • installer-local — Is the installation a local or packaged installation?

      (installer-local (installer installer))
    
  • installer-language — Language that the kernel supports.

      (setf (installer-language (installer installer)) new-value)
    
  • installer-language — Language that the kernel supports.

      (installer-language (installer installer))
    
  • installer-kernel-name — Name of the kernel.

      (setf (installer-kernel-name (installer installer)) new-value)
    
  • installer-kernel-name — Name of the kernel.

      (installer-kernel-name (installer installer))
    
  • installer-implementation — Path to specific binary used by the kernel.

      (setf (installer-implementation (installer installer)) new-value)
    
  • installer-implementation — Path to specific binary used by the kernel.

      (installer-implementation (installer installer))
    
  • installer-display-name — Name of the kernel displayed to the user.

      (setf (installer-display-name (installer installer)) new-value)
    
  • installer-display-name — Name of the kernel displayed to the user.

      (installer-display-name (installer installer))
    
  • installer-debugger — Whether or not the kernel supports debugging.

      (setf (installer-debugger (installer installer)) new-value)
    
  • installer-debugger — Whether or not the kernel supports debugging.

      (installer-debugger (installer installer))
    
  • installer-class — Class that implements the kernel. Used by image based installations.

      (setf (installer-class (installer installer)) new-value)
    
  • installer-class — Class that implements the kernel. Used by image based installations.

      (installer-class (installer installer))
    

user-installer

Class

User installer class.

Precedence List

user-installer, installer, standard-object, slot-object, t

Slots
  • class — Class that implements the kernel. Used by image based installations.
    • :initarg :class
  • debugger — Whether or not the kernel supports debugging.
    • :initarg :debugger
  • display-name — Name of the kernel displayed to the user.
    • :initarg :display-name
  • implementation — Path to specific binary used by the kernel.
    • :initarg :implementation
  • kernel-name — Name of the kernel.
    • :initarg :kernel-name
  • language — Language that the kernel supports.
    • :initarg :language
  • local — Is the installation a local or packaged installation?
    • :initarg :local
  • local-systems — List of systems to package into local-projects.
    • :initarg :local-systems
  • prefix — Directory to put installed files into. Used by packaging system, should be nil otherwise.
    • :initarg :prefix
  • resources — List of paths of resource files such as icons.
    • :initarg :resources
  • root — The root directory under which the Jupyter folder is found. If nil then it will be determined automatically.
    • :initarg :root
  • systems — List of systems to bundle for system installs.
    • :initarg :systems
Methods
  • install — Install user kernel.

      (install (instance user-installer))
    
  • installer-path-part — Get the root directory for a user installation

      (installer-path-part (instance user-installer) (type (eql root)))
    
  • install — Do common installation tasks before the specific ones association with this instance.

      (install (instance installer))
    
  • installer-systems — List of systems to bundle for system installs.

      (setf (installer-systems (installer installer)) new-value)
    
  • installer-systems — List of systems to bundle for system installs.

      (installer-systems (installer installer))
    
  • installer-root — The root directory under which the Jupyter folder is found. If nil then it will be determined automatically.

      (setf (installer-root (installer installer)) new-value)
    
  • installer-root — The root directory under which the Jupyter folder is found. If nil then it will be determined automatically.

      (installer-root (installer installer))
    
  • installer-resources — List of paths of resource files such as icons.

      (setf (installer-resources (installer installer)) new-value)
    
  • installer-resources — List of paths of resource files such as icons.

      (installer-resources (installer installer))
    
  • installer-prefix — Directory to put installed files into. Used by packaging system, should be nil otherwise.

      (setf (installer-prefix (installer installer)) new-value)
    
  • installer-prefix — Directory to put installed files into. Used by packaging system, should be nil otherwise.

      (installer-prefix (installer installer))
    
  • installer-local-systems — List of systems to package into local-projects.

      (setf (installer-local-systems (installer installer)) new-value)
    
  • installer-local-systems — List of systems to package into local-projects.

      (installer-local-systems (installer installer))
    
  • installer-local — Is the installation a local or packaged installation?

      (setf (installer-local (installer installer)) new-value)
    
  • installer-local — Is the installation a local or packaged installation?

      (installer-local (installer installer))
    
  • installer-language — Language that the kernel supports.

      (setf (installer-language (installer installer)) new-value)
    
  • installer-language — Language that the kernel supports.

      (installer-language (installer installer))
    
  • installer-kernel-name — Name of the kernel.

      (setf (installer-kernel-name (installer installer)) new-value)
    
  • installer-kernel-name — Name of the kernel.

      (installer-kernel-name (installer installer))
    
  • installer-implementation — Path to specific binary used by the kernel.

      (setf (installer-implementation (installer installer)) new-value)
    
  • installer-implementation — Path to specific binary used by the kernel.

      (installer-implementation (installer installer))
    
  • installer-display-name — Name of the kernel displayed to the user.

      (setf (installer-display-name (installer installer)) new-value)
    
  • installer-display-name — Name of the kernel displayed to the user.

      (installer-display-name (installer installer))
    
  • installer-debugger — Whether or not the kernel supports debugging.

      (setf (installer-debugger (installer installer)) new-value)
    
  • installer-debugger — Whether or not the kernel supports debugging.

      (installer-debugger (installer installer))
    
  • installer-class — Class that implements the kernel. Used by image based installations.

      (setf (installer-class (installer installer)) new-value)
    
  • installer-class — Class that implements the kernel. Used by image based installations.

      (installer-class (installer installer))
    

user-thread-p

Function

Return non-NIL if the current thread is not the control thread.

(user-thread-p)

vega

Function

Create a Vega result based on an inline value.

(vega value &key display update id)

vega-file

Function

Create a Vega graph based on a file path.

(vega-file path &key display update id)

vega-lite

Function

Create a VegaLite result based on an inline value.

(vega-lite value &key display update id)

vega-lite-file

Function

Create a VegaLite graph based on a file path.

(vega-lite-file path &key display update id)