PacletInstall

PacletInstall[paclet]

installs or updates paclet.

PacletInstall[task]

waits for completion of the task started by a call to PacletInstallSubmit.

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
    "http://..." or URL[…]absolute URL of a paclet archive file
    File[…]location of a paclet archive file
    CloudObject[…]cloud object containing a paclet archive file
    PacletObject[…]a reference to a paclet on a paclet site
  • PacletInstall returns a paclet object representing the newly installed paclet or the existing paclet if no update occurred, or $Failed if no such paclet is available.
  • PacletInstall will update an existing paclet of the same name if a newer version is available.
  • PacletInstall installs paclets into the Repository subdirectory of $UserBasePacletsDirectory.
  • By default, PacletInstall will look for a named paclet on all paclet sites given by PacletSites[].
  • When PacletInstall 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 Truewhether to update an existing paclet
    ForceVersionInstall Falsewhether to install the given paclet even if it is older than a currently installed version
    KeepExistingVersion Automaticwhether to delete the old version when updating
    PacletSite Automaticlook for the named paclet on a specific paclet site
    UpdatePacletSites Automaticwhether to update paclet information from all known sites before attempting the install

Examples

open allclose all

Basic Examples  (5)

Install a paclet from the Wolfram paclet server:

Install a paclet from a .paclet archive file:

If the paclet is already installed, and no update is available, the existing installed paclet is returned:

Install a specific version (the server has both 1.0 and 2.0 versions, and 2.0 would be installed by default):

No paclet of this name can be found on any known paclet site:

Options  (5)

AllowVersionUpdate  (1)

Uninstall any existing version of ExamplePaclet:

Now install Version 1.0 from the Wolfram paclet server:

ExamplePaclet also has a 2.0 version on the server, but the AllowVersionUpdateFalse option will prevent your local copy from being updated:

ForceVersionInstall  (1)

Uninstall any existing version of ExamplePaclet:

This will install Version 2.0 (the highest available version) from the Wolfram paclet server:

Attempts to install an older version will fail:

Use ForceVersionInstall to allow installing an older version when a newer one is already installed:

KeepExistingVersion  (1)

Uninstall any existing version of ExamplePaclet:

Now install Version 1.0 from the Wolfram paclet server:

ExamplePaclet also has a 2.0 version on the server, and the KeepExistingVersionTrue option will prevent your 1.0 version from being deleted when the 2.0 version is installed:

Both versions are present:

PacletSite  (1)

Use the PacletSite option to obtain a paclet from the specified site without registering the site as a permanent known site:

The site used is not present in the list of known paclet sites:

UpdatePacletSites  (1)

Use UpdatePacletSitesTrue to ensure that you have the latest information about what paclets are available from all known paclet sites:

Properties & Relations  (1)

If an asynchronous installation is initiated by a call to PacletInstallSubmit, you can choose to wait for the task to complete by calling PacletInstall on the task object:

The task will finish in the background, but if you want to wait until it is done, use the following:

Wolfram Research (2020), PacletInstall, Wolfram Language function, https://reference.wolfram.com/language/ref/PacletInstall.html.

Text

Wolfram Research (2020), PacletInstall, Wolfram Language function, https://reference.wolfram.com/language/ref/PacletInstall.html.

CMS

Wolfram Language. 2020. "PacletInstall." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/PacletInstall.html.

APA

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

BibTeX

@misc{reference.wolfram_2024_pacletinstall, author="Wolfram Research", title="{PacletInstall}", year="2020", howpublished="\url{https://reference.wolfram.com/language/ref/PacletInstall.html}", note=[Accessed: 22-November-2024 ]}

BibLaTeX

@online{reference.wolfram_2024_pacletinstall, organization={Wolfram Research}, title={PacletInstall}, year={2020}, url={https://reference.wolfram.com/language/ref/PacletInstall.html}, note=[Accessed: 22-November-2024 ]}