Metadata-Version: 2.2
Name: loop_cgal
Version: 0.1.6
Summary: python bindings for cgal for implicit model meshing
Author-Email: Lachlan Grose <lachlan.grose@monash.edu>
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.7
Requires-Dist: pyvista
Requires-Dist: vtk
Requires-Dist: scipy
Requires-Dist: numpy
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Description-Content-Type: text/markdown

# Loop-cgal

Loop-cgal is a Python package for mesh processing operations using the  CGAL (Computational Geometry Algorithms Library). It is designed for efficient geometric computations using pyvista objects.

## Features

- Python bindings for CGAL using `pybind11`.
- Current features:
    - clipping of 3D triangular surfaces
- Future features:
    - Marching cubes algorithm for isosurface extraction
    - Boolean operations on marching cube meshes.

## Installation

### Prerequisites

- C++17 or later
- Python 3.11 or later
- CGAL library
- Boost library
- CMake 3.15 or later
- pybind11
- scikit-build
- pyvista

### Build and Install

1. Clone the repository:
   ```bash
   git clone https://github.com/Loop3D/loop-cgal.git
   cd loop-cgal
   pip install .
   ```
2. Alternatively, you can install it directly from PyPI:
   ```bash
   pip install loop-cgal
   ```

### Windows using vcpkg

To install dependencies using [vcpkg](https://vcpkg.io/):

1. Install vcpkg following the [official guide](https://vcpkg.io/en/getting-started.html).
2. Install required libraries:
    ```bash
    vcpkg install yasm-tool:x86-windows cgal:x64-windows
    ```
3. Set the `VCPKG_ROOT` environment variable to point to your vcpkg installation directory.
4. Set the `CMAKE_ARGS` to include `-DCMAKE_TOOLCHAIN_FILE` and `-DVCPKG_ROOT` e.g. CMAKE_ARGS="-DCMAKE_TOOLCHAIN_FILE=$Env:VCPKG_ROOT\scripts\buildsystems\vcpkg.cmake -DVCPKG_ROOT=$Env:VCPKG_ROOT"
4. Proceed with the build and installation steps as described above.