Skip to content

Latest commit

 

History

History
55 lines (34 loc) · 2.06 KB

README.md

File metadata and controls

55 lines (34 loc) · 2.06 KB

Obtain/Build Easy3D Python bindings

Prebuilt Python bindings are available from the Releases page. Download the wheel file for your platform and Python version, and install it using pip.

If the prebuilt bindings are not available for your platform or specific version of Python, you can build it from the source code. Make sure you have Python installed. Then switch on the CMake option Easy3D_BUILD_PYTHON_BINDINGS, run CMake, and then build Easy3D. After building Easy3D, you can find the Python bindings module PyEasy3D (PyEasy3D.pyd on Windows, PyEasy3D.so on macOS/Linux) in YOUR_BUILD_DIRECTORY/lib/python/easy3d.

Use Easy3D bindings in Python code

After building the Python bindings, you should already be able to use the Python bindings module generated in YOUR_BUILD_DIRECTORY/lib/python/easy3d. Here is an example:

import sys
sys.path.append("YOUR_BUILD_DIRECTORY/lib/python")  # <-- Use your actual build path. Not required if the wheel is installed

import easy3d

easy3d.initialize()
viewer = easy3d.Viewer("Test")
viewer.add_model(easy3d.resource_directory() + "/data/bunny.ply")
viewer.run()

Note: the Python version used for running the code should match the version used for building the bindings.

Installation (Optional)

If you want to avoid specifying the path of the generated bindings in your Python code, you can create a wheel (.whl) file for the bindings and install it globally. This will make Easy3D work like other Python packages such as Numpy.

Below are the detailed steps for creating the wheel file and installation.

  • Step 1: Install the build tool (only if not installed)

    • pip install build

  • Step 2: Build the wheel

    • cd YOUR_BUILD_DIRECTORY/lib/python

    • python -m build

  • Step 3: Install the wheel

    • pip install dist/easy3d-2.6.0-py3-none-any.whl # <-- Use your actual wheel file name

    You can verify the installation by running the following command:

    • pip show easy3d