Getting Started

Prerequisites

Software

Python 3.10 or newer
PhoXi Control – must be running on your system
3D Instant Meshing Library – must be installed. The library version must match the version of the Python API.

Installation

(Optional) Create and activate a virtual environment:

python -m venv .venv
.\.venv\Scripts\activate

python -m venv .venv
source .venv/bin/activate

Install the package:
```
pip install phoxi-instant-meshing
```

Environment Variables

Before running any script, set the following environment variables:

Variable	Description
`RESOURCES_DIR`	Path to the dataset directory.
`PHOXI_CONTROL_PATH`	Path to the PhoXi Control installation directory.
`PHOIM_LIBRARY_PATH` (Windows)	Path to the 3D Instant Meshing library directory.
`LD_LIBRARY_PATH` (Linux)	Must include paths to both the 3D Instant Meshing library and the PhoXi API library.

$env:RESOURCES_DIR="C:\Program Files\Photoneo\3DInstantMeshing\2.3.0\API\examples\datasets"
$env:PHOIM_LIBRARY_PATH="C:\Program Files\Photoneo\3DInstantMeshing\2.3.0"
$env:PHOXI_CONTROL_PATH="C:\Program Files\Photoneo\PhoXiControl-1.16.4"

export RESOURCES_DIR=/opt/Photoneo/3DInstantMeshing/2.3.0/API/examples/datasets
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/opt/Photoneo/3DInstantMeshing/2.3.0
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/opt/Photoneo/PhoXiControl-1.16.4/API/lib
export PHOXI_CONTROL_PATH=/opt/Photoneo/PhoXiControl-1.16.4

Quick Start

For a complete working example including library setup, device connection, scan processing, and mesh export, see the Basic example on the Examples page.