Skip to content

Latest commit

 

History

History
93 lines (63 loc) · 3.33 KB

README.md

File metadata and controls

93 lines (63 loc) · 3.33 KB
Raw

Build PyMeshLab

Build scripts

We provide a set of platform dependent scripts that should make easier to build PyMeshLab. Scripts can be found here. Otherwise, if you want to build manually PyMeshLab, you can follow these instructions.

Source code

The source code of pymeshlab is contained inside the src/pymeshlab directory. To see how it is organized, see the contained README.md. Inside the src directory there are also two directories:

  • meshlab: contains the subrepository of MeshLab;
  • utilities: contains some utilities necessary to deploy pymeshlab on specific platforms.

Requirements

To be built, PyMeshLab requires a C++14 compiler (gcc, clang and MSVC are supported), CMake >= 3.9, Python >= 3.6 and Qt = 5.15.

Clone

Clone this repository with the --recursive flag, needed to clone also MeshLab, pybind11 and other external repositories:

git clone --recursive https://github.com/cnr-isti-vclab/PyMeshLab.git

Other plugins

To build some additional plugins, some libraries that are not bundled in the repository are required. Therefore, you'll need to install them separately.

linux

sudo apt install libgmp-dev libcgal-dev libboost-all-dev

macos

brew install libomp cgal xerces-c

windows

You can use the bash script that will download and extract automatically the boost and cgal libraries:

bash src/meshlab/scripts/windows/0_download_ext.sh

Build

To build PyMeshLab, just run:

mkdir src/build
cd src/build
cmake ..
make
make install

or, on Windows:

mkdir src\build
cd src\build
cmake -G "NMake Makefiles" ..
nmake
nmake install

By default, PyMeshLab will be installed inside the pymeshlab directory of the repo. Therefore, after installed, you can just cd to the root of this repository and then import pymeshlab from a python shell.

Build options

By default, the scripts listed above will build a pymeshlab python module. There are two additional options in the CMake configuration:

  • BUILD_PYMESHLAB_DEBUG (default: OFF): if set to ON, pymeshlab will be built in debug mode, and instead of building pymeshlab/main.cpp, the file pymeshlab/debug_main.cpp will be built . This file contains a main function set to call pymeshlab functions under C++ and therefore allows to debug pymeshlab under a full C++ environment;
  • BUILD_PYMESHLAB_UPDATE_DOC (default: OFF): if set to ON, pymeshlab will be built but with pymeshlab/doc_main.cpp instead of pymeshlab/main.cpp. This build system will generate an executable that will automatically update the file docs/filter_list.rst, containing the documentation of the pymeshlab filter.

Deploy PyMeshLab

By executing the above instruction, the installed pymeshlab directory will not be a self-contained pymeshlab directory (it will depend on Qt libs that are installed in the system). To make pymeshlab portable, we provide some scripts that you can find in the scripts directory in the root of this repo.

sh scripts/[platform]/1_build.sh
sh scripts/[platform]/2_deploy.sh

For more details, please take a look at the relative readme and at the Github Actions Workflows that use them to automatically build PyMeshLab in all the platforms.