Help for installation
Script module
A script module (Tcl or Python) is generally represented by a pair of files, one with extension .rc (resource) and another with extension either .scro or .pyscro (script object or Python script object). It can be packaged with some documentation files. This help page focuses on the local/ directory that contains those files.
Note that an Xtra archive might also contain some additional directories or files, such as sample data, example projects, or tutorial files, that you can save wherever you find it convenient.
The content of the Xtra local/ directory can be either copy-pasted to the product installation folder - also named AMIRA_ROOT, AVIZO_ROOT, PERGEOS_ROOT - or to an independent custom-defined folder,
thereafter named AMIRA_LOCAL.
Installation in the software installation folder:
The custom resource will be accessible to all users of the computer. In case you have several versions of the product installed, the custom resource will only be available in the selected version of the software. In case you upgrade the version of Amira-Avizo Software or PerGeos Software, you will have to re-install the resources. Un-installation is not necessarily simple, as you need to remember which files have been added to the installation folder.
The custom resources are loaded at the startup of the application, so you may have to restart the software for the script modules to be accessible.
Installation in an independent custom-defined folder:
Each user can decide to connect or not to the directory, that may be shared on the network. The resources will be available from all the installed versions of the product, however compatibility is not guaranteed with all versions (see each Xtra page for its specific compatibility information). It is also simpler, when upgrading the software, to connect to the directory. Again, note that compatibility cannot be guaranteed when upgrading the version of the software.
To use a custom-defined directory (this is also described in the video above):
- create a directory, somewhere on your computer where you have write permissions.
- set an environment variable named AMIRA_LOCAL, and have it point to the specified directory. Under Windows: you may use a free software like Rapid Environment Editor to set it easily ; or go to Start->Control Panel and search 'environment variables', and Edit Environment Variables for your account.
- note that the variable AMIRA_LOCAL will work the same regardless of the installed product(s): Amira Software, Avizo Software or PerGeos Software. This is not the case for the variable AVIZO_LOCAL (that can be used with Avizo Software), or PERGEOS_LOCAL (with PerGeos Software).
- note that if you have installed the XPand extension, you can define the Amira (or Avizo, or PerGeos) local directory from the Development Wizard (available from the XPand menu).
- this directory is defined only for the selected version of the product, likewise the custom resource will only be available in the selected version of the product.
- if you define the environment variable AMIRA_LOCAL as described in the previous lines, it will prevail over the location you might have defined from the XPand menu.
The custom resources are loaded at the startup of the application, so you may have to restart the software for the script modules to be accessible.
More information is available in the user's guide, section: Automating, Customizing, Extending.
Additional resource: