Install

Install["name"]

starts a WSTP-compatible external program and installs Wolfram Language definitions to call functions in it.

Details and Options

  • The Wolfram Language definitions set up by Install are typically specified in the WSTP template file used to create the source code for the external program.
  • Install["prog"] will launch the specified program, then connect to it via WSTP.
  • If prog is a directory, Install["prog"] will try to execute prog/$SystemID/prog.
  • Install[File["name"]] is equivalent to Install["name"].
  • Install["name`"] searches all directories on $Path for a file or directory called name.exe.
  • Install[link] will take an existing LinkObject and set up what is needed to call functions in the program corresponding to that LinkObject.
  • Install returns a LinkObject representing the WSTP connection it is using.
  • LinkPatterns[link] gives a list of the patterns defined when the specified link was set up.
  • You can remove these definitions and terminate the execution of the external program by calling Uninstall[link].
  • Install[LinkConnect["port"]] will install an external program that has created a link on the specified port. You can use this to call external programs that have been started in a debugger or on a remote computer system.
  • If you call Install["command"] multiple times with the same command, the later calls will overwrite definitions set up by earlier ones, unless the definitions depend on the values of global variables that have changed.
  • Install sets up definitions that send CallPacket objects to the external program whenever functions in it are called, and waits for results to be returned in ReturnPacket objects.
  • The external program can send EvaluatePacket objects back to the Wolfram Language to request evaluations while the program is running.

Examples

open allclose all

Basic Examples  (1)

Set the directory:

Install an external WSTP-compatible program:

Get usage information about linked-in symbols:

Use the new function:

Terminate the external program:

Reset to the original directory:

Scope  (1)

Set the directory:

Install an external WSTP-compatible program:

Get the complete set of LinkPatterns installed:

Get usage information about linked-in symbols:

Use the new function:

Uninstall the external program:

Reset to the original directory:

Wolfram Research (1991), Install, Wolfram Language function, https://reference.wolfram.com/language/ref/Install.html (updated 2016).

Text

Wolfram Research (1991), Install, Wolfram Language function, https://reference.wolfram.com/language/ref/Install.html (updated 2016).

BibTeX

@misc{reference.wolfram_2020_install, author="Wolfram Research", title="{Install}", year="2016", howpublished="\url{https://reference.wolfram.com/language/ref/Install.html}", note=[Accessed: 16-April-2021 ]}

BibLaTeX

@online{reference.wolfram_2020_install, organization={Wolfram Research}, title={Install}, year={2016}, url={https://reference.wolfram.com/language/ref/Install.html}, note=[Accessed: 16-April-2021 ]}

CMS

Wolfram Language. 1991. "Install." Wolfram Language & System Documentation Center. Wolfram Research. Last Modified 2016. https://reference.wolfram.com/language/ref/Install.html.

APA

Wolfram Language. (1991). Install. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/Install.html