¶Installation

¶Maya

Adonis is distributed for Maya as a standard module (.mod). To install the module, follow these steps:

1. Download the Adonis package from Inbibo’s website.
2. Extract the contents into any folder of your choice.
3. Add the path to that extracted folder to the MAYA_MODULE_PATH environment variable (details below).
4. Launch Maya and load Adonis from Windows > Settings/Preferences > Plug-in Manager.

When Maya starts, it evaluates all directories listed in MAYA_MODULE_PATH to locate module files such as Adonis.mod. Therefore, the environment variable must include the folder containing that file.

There are two ways to configure MAYA_MODULE_PATH:

• Method 1: Set the value inside the Maya.env configuration file
• Method 2: Set the value as a system-wide or user-wide environment variable

¶Windows

Method 1: Configure Maya.env

1. The default location of the Maya.env file is drive:/Users/username/Documents/maya/%MAYA_VERSION%.
2. Add MAYA_MODULE_PATH = drive:/path/to/Adonis/folder to the file.
3. Adonis will be loaded the next time you launch Maya.

Method 2: Configure System Environment

1. Open the System Properties window which can be found by searching for environment variables in the Windows search bar.
2. Click on Environment Variables and a new window will be displayed showing all the environment variables configured at the system level and for the current user.
3. Click on New... button for the level that you prefer (system or user) and configure MAYA_MODULE_PATH with the path containing the Adonis.mod file.
4. Adonis will be loaded the next time you launch Maya.

¶Linux

Method 1: Configure Maya.env

1. The default location of the Maya.env file is ~/maya/$MAYA_VERSION.
2. Add MAYA_MODULE_PATH = /path/to/Adonis/folder to the file.
3. Adonis will be loaded the next time you launch Maya.

Method 2: Configure System Environment

1. From the terminal, open your preferred text editor to modify the file ~/.bashrc.

2. Add this command to export the environment variable:

   export MAYA_MODULE_PATH="/path/to/Adonis/folder:${MAYA_MODULE_PATH}"

3. Adonis will be loaded the next time you launch Maya.

¶Houdini

Adonis is distributed for Houdini as a standard package (.json). To install the package, please do the following:

1. Download the Adonis package from Inbibo’s website.
2. Extract the contents into any folder of your choice.
3. Add the path to that extracted folder to the HOUDINI_PACKAGE_DIR and ADN_INSTALL_PATH environment variables.
4. Launch Houdini and the Adonis package will be automatically loaded.

When Houdini starts up, it evaluates all paths pointed by the HOUDINI_PACKAGE_DIR environment variable to search for packages that are typically defined as JSON files. In order to allow Houdini to find Adonis, that environment variable has to include the path where the Adonis.json file is located.

The need to set ADN_INSTALL_PATH as well is to allow Houdini to complete the environment configuration using paths relative to the Adonis installation folder.

In the following sections we explain how to do this for Windows and Linux.

¶Windows

1. Open the System Properties window which can be found by searching for environment variables in the Windows search bar.
2. Click on Environment Variables and a new window will be displayed showing all the environment variables configured at the system level and for the current user.
3. Click on New... button for the level that you prefer (system or user) and configure HOUDINI_PACKAGE_DIR with the path containing the Adonis.json file.
4. Do the same for ADN_INSTALL_PATH.
5. Adonis will be loaded the next time you launch Houdini.

¶Linux

1. From the terminal, open your preferred text editor to modify the file ~/.bashrc.

2. Add the command to export HOUDINI_PACKAGE_DIR as follows:

   export HOUDINI_PACKAGE_DIR="/path/to/Adonis/folder:${HOUDINI_PACKAGE_DIR}"

3. Add also the command to export ADN_INSTALL_PATH:

   export ADN_INSTALL_PATH="/path/to/Adonis/folder"

4. Adonis will be loaded the next time you launch Houdini.

¶ML Dependencies

Some Adonis features require additional Python libraries to be installed. These dependencies are used for:

• Training, when running neural network training through the Training Script or the Neural Training Tool.
• Inference, when evaluating trained models on the GPU through AdnMLDeformer or AdnSmartTissue.

The ML dependencies are not installed by default and must be installed separately before using any of these features.

ML dependencies can be installed in the following ways:

1. From within Maya or Houdini using Adonis > Utils > Install ML Dependencies.
2. Through the Neural Training Tool. When starting a training session, the tool automatically checks whether the required dependencies are available and, if not, prompts the user to install them before training begins.
3. Using the standalone installation script in Adonis/python/adnml/install_dependencies (.bat in Windows; .sh in Linux).

The last method is particularly useful when running training through the Training Script outside of Maya or Houdini, or when preparing a machine for automated training workflows.

Installing the dependencies may take a few minutes.