# libigl-python-bindings

**Repository Path**: mirrors_lepy/libigl-python-bindings

## Basic Information

- **Project Name**: libigl-python-bindings
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-06-24
- **Last Updated**: 2023-08-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# libigl Python Bindings
[![Build Status](https://travis-ci.com/libigl/libigl-python-bindings.svg?branch=master)](https://travis-ci.com/libigl/libigl-python-bindings)
[![Build Status](https://dev.azure.com/libigl/Libigl/_apis/build/status/libigl.libigl-python-bindings?branchName=master)](https://dev.azure.com/libigl/Libigl/_build/latest?definitionId=1&branchName=master)

This repository contains the source code for the new and improved LibIGL Python bindings. These bindings are fully compatible with NumPy and SciPy and offer a convenient interface similar to functions in those libraries.

These bindings are still under active development and should still be considered alpha quality. We encourage users to post issues so we can improve the bindings!

## Installation

### With Conda (Recommended)
The simplest and best way to install the new LibIGL Python bindings is to run:
```
conda install -c conda-forge igl
```

### Compile from scratch (Not recommended)
If you wish to install the current master branch, you can compile the library from scratch, you can clone this repository and run the following command from the main directory:
```
python setup.py install
```

**NOTE:** We will not provide support for installations done in this way, since there is a lot of variation between systems. For a consistent experience, use conda.

## [Help/Documentation](https://libigl.github.io/libigl-python-bindings/)
* A *temporary* tutorial on how to use the bindings can be found [here](https://libigl.github.io/libigl-python-bindings/tutorials/)
* A *temporary* function reference can be found [here](https://libigl.github.io/libigl-python-bindings/igl_docs/)


## Compiling and modifying the bindings
After cloning this repository, you can compile the bindings from scratch by running:
```
python setup.py develop
```
or
```
python setup.py build --debug develop
```
for debug compilation.

The above command will make the package `igl` available for import in the current shell.

To run the tests:
```
python setup.py test
```