PacletInstallSubmit
PacletInstallSubmit[paclet]
asynchronously installs or updates paclet.
Details and Options
- Paclets can be specified in any of the following ways:
-
"name" name of a paclet at a known paclet site "name""version" a specific version of a paclet PacletObject[…] a reference to a paclet on a paclet site - PacletInstallSubmit returns an AsynchronousTaskObject representing the download and install operation that is occurring in the background, or the existing paclet if no update occurred, or $Failed if no such paclet is available.
- You can use operations like WaitAsynchronousTask to operate on the running task.
- PacletInstallSubmit will update an existing paclet of the same name if a newer version is available.
- PacletInstallSubmit installs paclets into the Repository subdirectory of $UserBasePacletsDirectory.
- By default, PacletInstallSubmit will look for a named paclet on all paclet sites given by PacletSites[].
- When PacletInstallSubmit updates a paclet, it will delete the old version if the new one has the same requirements as the old one.
- You can use PacletInstall on the result of a call to PacletInstallSubmit to wait for the installation to complete.
- The following options can be given:
-
AllowVersionUpdate True whether to update an existing paclet ForceVersionInstall False whether to install the given paclet even if it is older than a currently installed version KeepExistingVersion Automatic whether to delete the old version when updating PacletSite Automatic look for the named paclet on a specific paclet site UpdatePacletSites Automatic whether to update paclet information from all known sites before attempting the install
Examples
open all close allBasic Examples (3)
Install a paclet from the Wolfram paclet server:
PacletInstallSubmit["ExamplePaclet"]The task will finish in the background. You can choose to wait for completion:
WaitAsynchronousTask[%]The paclet has been installed:
PacletFind["ExamplePaclet"]If the paclet is already installed, and no update is available, the existing installed paclet is returned:
PacletInstallSubmit["JLink"]%["Location"]No paclet of this name can be found on any known paclet site:
PacletInstallSubmit["DoesntExist"]
Options (5)
AllowVersionUpdate (1)
PacletUninstall["ExamplePaclet"];Now install Version 1.0 from the Wolfram paclet server:
PacletInstallSubmit["ExamplePaclet" -> "1.0"]ExamplePaclet also has a 2.0 version on the server, but the AllowVersionUpdateFalse option will prevent your local copy from being updated:
PacletInstallSubmit["ExamplePaclet", AllowVersionUpdate -> False]ForceVersionInstall (1)
Uninstall any existing version of ExamplePaclet:
PacletUninstall["ExamplePaclet"]This will install Version 2.0 (the highest available version) from the Wolfram paclet server:
PacletInstallSubmit["ExamplePaclet"]Attempts to install an older version will fail:
PacletInstallSubmit["ExamplePaclet" -> "1.0"]
Use ForceVersionInstall to allow installing an older version when a newer one is already installed:
PacletInstallSubmit["ExamplePaclet" -> "1.0", ForceVersionInstall -> True]KeepExistingVersion (1)
Uninstall any existing version of ExamplePaclet:
PacletUninstall["ExamplePaclet"]Now install Version 1.0 from the Wolfram paclet server:
PacletInstallSubmit["ExamplePaclet" -> "1.0"]ExamplePaclet also has a 2.0 version on the server, and the KeepExistingVersionFalse option will prevent your 1.0 version from being deleted when the 2.0 version is installed:
PacletInstallSubmit["ExamplePaclet", KeepExistingVersion -> True]PacletFind["ExamplePaclet"]PacletSite (1)
Use the PacletSite option to obtain a paclet from the specified site without registering the site as a permanent known site:
PacletInstallSubmit["MyPaclet", PacletSite -> "http://mycompany.com/MyPacletSite"];The site used is not present in the list of known paclet sites:
PacletSites[]UpdatePacletSites (1)
Use UpdatePacletSitesTrue to ensure that you have the latest information about what paclets are available from all known paclet sites:
PacletInstallSubmit["ExamplePaclet", UpdatePacletSites -> True]Properties & Relations (1)
You can use PacletInstall to wait for the task started by PacletInstallSubmit to finish.
Uninstall any existing ExamplePaclet:
PacletUninstall["ExamplePaclet"]Begin the download and installation procedure:
task = PacletInstallSubmit["ExamplePaclet"]The task will finish in the background, but you can use PacletInstall to wait for it to complete:
PacletInstall[task]Text
Wolfram Research (2020), PacletInstallSubmit, Wolfram Language function, https://reference.wolfram.com/language/ref/PacletInstallSubmit.html.
CMS
Wolfram Language. 2020. "PacletInstallSubmit." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/PacletInstallSubmit.html.
APA
Wolfram Language. (2020). PacletInstallSubmit. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/PacletInstallSubmit.html