Installation

Catalina (OSX 10.15) Update

From OSX 10.15 (Catalina), there has been increased security to applications and plugins installed from unidentified developers. Follow these steps below prior to Installation (below).

• Open the Terminal application from Applications/Utilities
• Disable Gatekeeper by entering the following command:

sudo spctl --master-disable

• Go to System Preferences/Security & Privacy.
• Under the General tab, ensure that "Allow apps downloaded from" is selected as "Anywhere".
• Follow the steps for Installation (below), and then re-enable the Gatekeeper by typing the following command in Terminal:

sudo spctl --master-enable

Installation

To get started with pyOsiriX follow these steps:

1. Ensure you have downloaded the latest version of OsiriX or Horos.
2. Download the latest release of pyOsiriX and unzip.
3. Drag the pyOsiriX.osirixplugin file onto either the OsiriX or Horos applications and follow the prompts for installation.
4. Restart OsiriX/Horos
5. Check that a new plugin option is given in the 'Plugins/Database' menu bar.

6. Right-click the OsiriX browser toolbar and select "Customize Toolbar..."

7. Drag the pyOsiriX button to the toolbar (the same can be done for 2D and 3D viewers)

8. The pyOsiriX terminal and any installed python scripts can be started from the new menu option

9. Within the terminal, python scripts can be run; outputs are logged within the uppermost text box.

10. For documentation of the inbuilt functions with pyOsiriX type "help(osirix)" into the terminal, and be safe!