Launching IPSDK Explorer

IPSDK Explorer is a Python application provided with IPSDK. Although it can be called directly from a python interpreter, this application provides a more user friendly approach to launch IPSDK Explorer as a standard binary file.

Note: PyIPSDK must be installed in the python environment, the user has to run <IPSDK_INSTALLATION_ROOT_DIR>/python/installation/setup.py before launching the application.

In addition, this application checks is a valid path to a python executable is defined. If not, the user is asked to specify one.

Note: IPSDK Explorer recquires some specific modules. To avoid to break an existing configuration, the user is charged to configure a compatible environment to run IPSDK Explorer. The exhaustive list of required modules can be found in the section Required modules.

Please, keep in mind that this application purpose is to create a new process to launch the Explorer software in a Python environment. If an the program encountered an unhandled error and crashes, Windows users can find the log file in the directory C:<USER><VERSION><VERSION>_x64. Linux users will find this log in the directory $HOME/.local/ReactivIP/IPSDK_<VERSION><VERSION>_x64. The ile name has the format Explorer_YYYY-MM-DD_HH-mm-ss.log

It is also possible to call the application with argument, see below for more details.

Usage

The application can be called through a command line as follows:

   <application_exe_filename> [--pythonPath <path_to_python_executable>]
     
   Arguments:
      --pythonPath      valid path to python executable 
                        (optional; WARNING: it a path already exists, it will be replaced by the new path). Please, avoid '\\'
      --enableDebugMode enables debug mode (for  Windows only).
                        Enabling debug mode does not hide the console (optional; the debug mode is disabled by default)

Required modules

To run IPSDK explorer, you need several modules. We recommend to create a specific environment if you fear to break an existing configuration. The versions we tested are:

czifile (2019.7.2)
keyboard (0.13.5)
matplotlib (3.9.4)
napariall
napari-animation (0.0.8)
napari-threedee (0.0.28)
nibabel (5.3.2)
numpy (1.23.5)
numpy-stl (3.2.0)
olefile (0.47)
opencv-python (4.10.0.84)
openpyxl (3.1.5)
pillow (11.1.0)
PyOpenGL (3.1.5)
PyQt5 (5.15.11)
QScintilla (2.14.1)
qtconsole (5.6.1)
reportlab (4.2.5)
scikit-learn (1.6.1)
tifffile (2024.8.30)
vtk (9.4.1)
vtkplotlib (2.1.1)
xlwt (1.3.0)

A file called requirements.txt is provided to help configuring a python environment. This file is located in <IPSDK_ROOT_DIR>/python/Explorer for a ToolKit/Partner installation and in <IPSDK_ROOT_DIR>/Explorer in an IPSDKExplorer standalone installation, where <IPSDK_ROOT_DIR> is the IPSDK root installation directory. Assuming the current directory is IPSDK Explorer's folder, you can use this file to directly install all IPSDK Explorer's dependancies with the command:

pip install -r requirements.txt