Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cnr-isti-vclab/PyMeshLab

The open source mesh processing python library
https://github.com/cnr-isti-vclab/PyMeshLab

Last synced: about 2 months ago
JSON representation

The open source mesh processing python library

Awesome Lists containing this project

README

        

# PyMeshLab

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4438750.svg)](https://doi.org/10.5281/zenodo.4438750)

[![BuildAndTest](https://github.com/cnr-isti-vclab/PyMeshLab/actions/workflows/BuildAndTest.yml/badge.svg)](https://github.com/cnr-isti-vclab/PyMeshLab/actions/workflows/BuildAndTest.yml)

[![Documentation Status](https://readthedocs.org/projects/pymeshlab/badge/?version=latest)](https://pymeshlab.readthedocs.io/en/latest/?badge=latest)
[![Downloads](https://pepy.tech/badge/pymeshlab)](https://pepy.tech/project/pymeshlab)

PyMeshLab is a Python library that interfaces to [MeshLab](https://github.com/cnr-isti-vclab/meshlab), the popular open source application for editing and processing large 3D triangle meshes. Python bindings are generated using [pybind11](https://github.com/pybind/pybind11).

## Documentation

You can find the official documentation [here](https://pymeshlab.readthedocs.io/).

## Install PyMeshLab

You can easily install PyMeshLab using pip:
```
pip3 install pymeshlab
```

### Note about Conda

PyMeshLab has not been tested in a Conda environment, so we cannot provide support for it. If possible, please install PyMeshLab using `pip` outside of Conda.
If you are a Conda developer and would like to contribute to making PyMeshLab compatible with Conda, pull requests are always appreciated :)

## Run PyMeshLab

After installing PyMeshLab through pip:
```
python
>>> import pymeshlab
>>> ms = pymeshlab.MeshSet()
```
You can load, save meshes and apply MeshLab filters:
```
ms.load_new_mesh('airplane.obj')
ms.generate_convex_hull()
ms.save_current_mesh('convex_hull.ply')
```

And apply filters with your parameters:
```
ms.create_noisy_isosurface(resolution=128)
```

You can find all the names and parameters of the filters in the [List of Filters](https://pymeshlab.readthedocs.io/en/latest/filter_list.html) page of the documentation.

To run the tests:
```
pip3 install pytest
pytest --pyargs pymeshlab
```

## Build PyMeshLab

See the [`src`](src/README.md) folder that contains the instructions to build PyMeshLab.

## License

The PyMeshlab source is released under the [GPL License](LICENSE).

## Copyright

```
PyMeshLab
All rights reserved.

VCGLib http://www.vcglib.net o o
Visual and Computer Graphics Library o o
_ O _
Paolo Cignoni \/)\/
Visual Computing Lab http://vcg.isti.cnr.it /\/|
ISTI - Italian National Research Council |
Copyright(C) 2020 \
```
## References
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4438750.svg)](https://doi.org/10.5281/zenodo.4438750)

Please, when using this tool, cite:
```
@software{pymeshlab,
author = {Alessandro Muntoni and Paolo Cignoni},
title = {{PyMeshLab}},
month = jan,
year = 2021,
publisher = {Zenodo},
doi = {10.5281/zenodo.4438750}
}
```

## Contacts

- Paolo Cignoni (paolo.cignoni (at) isti.cnr.it)
- Alessandro Muntoni (alessandro.muntoni (at) isti.cnr.it)

## Feedback

For documented and repeatable bugs, feature requests, etc., please use the [GitHub issues](https://github.com/cnr-isti-vclab/PyMeshLab/issues).