atomsInstall

Arguments

modules

m x 1, m x 2 matrix of strings

1st Col. (Mandatory)	2nd Col. (Optional)
Technical name	Version: if this field is empty or is not present, the most recent version is used

file

m x 1 matrix of strings containing the file-system path.

section

This argument controls where the external module is installed.

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

• "allusers": the external module is installed for all users of the computer and is located in SCI/contrib ("allusers zone").

• "user": the external module is only installed for the current user and is located in SCIHOME/atoms ("user zone").

If SCI/contrib is write accessible, "allusers" is the default value. Otherwise, the default value is "user".

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

atomsInstall installs one or several external modules.

By default, atomsInstall tries to install modules from ATOMS remote repositories. To install a module from a local file, you have to switch ATOMS to offline mode by using atomsSetConfig("offline","True")" command.

Examples

Example 1: Installing a module from a repository

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

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

// Install a module
atomsInstall("toolbox_1V6");

// Install a specific version
atomsInstall(["toolbox_2V6" "2.0"]);

// Install several modules
atomsInstall(["toolbox_4V6" "1.0" ; "toolbox_2V6" "1.0"]);

// Install a module in the user section
atomsInstall(["toolbox_5V6"], "user");

// Install a module in the allusers section
// (write access on SCI directory is needed):
atomsInstall(["toolbox_6V6" "1.0";"toolbox_3V6" "1.0"], "allusers");

// Get the list of installed modules:
disp( atomsGetInstalled() );

// Cleaning
atomsRemove(["toolbox_1V6"; ..
             "toolbox_2V6"; ..
             "toolbox_3V6"; ..
             "toolbox_4V6"; ..
             "toolbox_5V6"; ..
             "toolbox_6V6"]);
atomsRepositoryDel(repository);
atomsSystemUpdate();

Example 2: Installing a module from a local archive. As well as installing modules from the central repository, you can also install modules directly from your own machine.

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

// Switch to offline mode
atomsSetConfig("offLine","True");

// Install a module
atomsInstall(SCI+"/modules/atoms/tests/unit_tests/toolbox_7V6_1.0-1.bin.zip");

// Get the list of installed modules:
disp( atomsGetInstalled() );

// Cleaning
atomsRemove("toolbox_7V6");

// Back to default mode
atomsSetConfig("offLine","False");

See also

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

History