atomsRemove

Arguments

modules

m x 1 or m x 2 matrix of strings

1st Col. (Mandatory)	2nd Col. (Optional)
Technical name	Version: if this field is empty or is not present, all versions of the module are removed.

section

This argument controls the list of sections where search modules to remove.

section is a single-string and its value should be :

• "all": Modules to remove are searched in both "user" and "allusers" sections.

• "allusers": Modules to remove are only searched in the "allusers" section.

• "user": Modules to remove are only searched in the "user" section.

If SCI is write accessible, "all" is the default value. Otherwise, the default value is "user".

delete

delete is a boolean. If set to %T (True), the .zip or .tar.gz file containing the sources will also be deleted. This includes the dependencies' archives files that were installed with the module, if any.

result

m x 5 matrix of strings

1st Col.	2nd Col.	3rd Col.	4th Col.	5th Col.
Technical name	Version	Installation section: this parameter determines whether the module has been installed for all users or only for the current user.	Installation path	Status: "I" stands for "Intentionally", "A" stands for "Automatically"

Description

atomsRemove remove one or more modules.

Examples

// Display some additional information
atomsSetConfig("Verbose","True");

// Load the test repository
exec("SCI/modules/atoms/tests/unit_tests/atomsTestUtils.sce", -1);
repository = atomsCreateTestRepository("scene11");

// Install toolbox_4: both 1.0 and 1.1 versions

// Remove all versions of a module
atomsInstall(["toolbox_4V6" "1.0";"toolbox_4V6" "1.1"],"user");
atomsRemove(["toolbox_4V6"]);

// Remove a specific version
atomsInstall(["toolbox_4V6" "1.0";"toolbox_4V6" "1.1"],"user");
atomsRemove(["toolbox_4V6" "1.0"]);
atomsRemove(["toolbox_4V6" "1.1"]);

// Remove several modules
atomsInstall(["toolbox_4V6";"toolbox_3V6"],"user");
atomsRemove(["toolbox_4V6";"toolbox_3V6"]);

// Remove a module from a specific section
// /!\ This example needs write access on SCI directory

atomsInstall("toolbox_4V6","user");
atomsInstall("toolbox_4V6","allusers");

disp(atomsGetInstalled());
atomsRemove("toolbox_4V6","user");
disp(atomsGetInstalled());
atomsRemove("toolbox_4V6","allusers");
disp(atomsGetInstalled());

// Remove a module, including its archive file

atomsInstall("toolbox_4V6");
atomsRemove("toolbox_4V6",%T);

// Remove a module from a specific section, including its archive file
// /!\ This example needs write access on SCI directory

atomsInstall("toolbox_4V6");
atomsRemove("toolbox_4V6","allusers",%T);

// Unload the test repository
atomsRepositoryDel(repository);

See also

• atomsInstall — Install one or several external modules
• atomsIsInstalled — Determines whether the module is installed. Returns true if the module is installed, false otherwise.
• atomsGetInstalled — Get the list of installed external modules