CARIS provides bindings for scripting with the Python programming language. These bindings provide a simple, consistent model to automate and integrate data and operations with external functions and software.

Table Of Contents

Previous topic


Next topic

BDB Server Module


When all prerequisites have been installed, a system environment variable pythonpath must be set pointing to the location of the Python module in the BDB installation folder. This can be done at the start of a scripting session, or set permanently in the operating system.

To set this environment variable in a scripting session, enter the following command line for each application respectively:

For a BASE Editor installation:

set pythonpath=%pythonpath%;C:/Program Files/CARIS/BDB/4.1/python

For a BDB Server installation:

set pythonpath=%pythonpath%;C:/Program Files/CARIS/BDB Server/4.1/python

To permanently set this environment variable in the operating system:

  • Navigate to the system settings in Control Panel > System > Advanced tab.
  • Click Environment Variables.
  • Under System variables, click New.
  • Enter the Variable name pythonpath and Variable value C:/Program Files/CARIS/BDB/4.1/python (or variation as outlined above).


%pythonpath%; is only needed when defining the variable in a command line session.

Testing Python

To test the Python bindings for BDB Server: – Open a command prompt window and navigate to the Python installation folder. – Start the Python console interface by typing “Python” and pressing Enter. – Enter the following:

import caris.bathy.db

If there are no errors or warnings generated after executing this statement, the Python bindings for BDB Server have been successfully configured.