Gpytoolbox: A Python Geometry Processing Toolbox
This is a very young library of general geometry processing Python research utility functions that evolves from our personal student codebases.
Latest stable release (recommended)
You should be able install the latest release of Gpytoolbox with pip:
python -m pip install gpytoolbox
A conda installation will be supported in the future.
If you want to build Gpytoolbox from a specific git commit; for example, because
you want to develop for Gpytoolbox or because you want some functionality that
is in the
main branch but hasn't been pushed to any release yet, you should be
able to do so by cloning Gpytoolbox's github
repo and running
python -m pip install numpy python -m pip install .
You can find documentation for all our functions by browsing this website. You
can also view the documentation for a specific function by running
function_name.__doc__; for example,
>>> from gpytoolbox import grad >>> help(grad) Finite element gradient matrix Given a triangle mesh or a polyline, computes the finite element gradient matrix assuming piecewise linear hat function basis. Parameters ---------- V : numpy double array Matrix of vertex coordinates F : numpy int array, optional (default None) Matrix of triangle indices Returns ------- G : scipy sparse.csr_matrix Sparse FEM gradient matrix See Also -------- cotangent_laplacian. Notes ----- Examples -------- TO-DO
We hope you find our current version of our library useful. At the same time, we encourage you to ask not what Gpytoolbox can do for you, but what you can do for Gpytoolbox.
Since Gpytoolbox is a very young library, we want to make it as easy as possible
for others to contribute to it and help it grow. You can contribute by adding a
new function in a new file inside
src/gpytoolbox/, or by adding to existing
functions, and submitting a Pull
We also want to make the contribution process as unintimidating as possible. We will gladly review and edit your code to make sure it acommodates to our standards and we have set up many tests that will let us know if your contribution accidentally breaks anything. If there's any functionality that is not already in this library, is remotely related to geometry processing, and you have used or used in any of your past projects, we encourage you to submit it as-is in a Pull Request. We will gladly credit you in the individual function as well as on this home page.
Gpytoolbox's is released under an MIT license (see details),
except for files in the
gpytoolbox.copyleft module, which are under a GPL one
(see details). Functions in the copyleft module must be imported
explicitly; this way, if you import only the main Gpytoolbox module
or individual functions from it,
from gpytoolbox import regular_square_mesh, regular_cube_mesh
you are only bound by the terms of the permissive MIT license. However, if you
import any functionality from
from gpytoolbox.copyleft import mesh_boolean
you will be bound by the more restrictive GPL license.
Several people have, knowingly or unknowingly, greatly contributed to this library. We are thankful to them:
Alec Jacobson is the author of the original Matlab gptoolbox on which we inspired ourselves to create this library. Several of our functions are line-by-line translations of his Matlab ones. Thanks, Alec!