Release v0.9.0

v0.9.0 - 2024-09-13

Breaking

• The private TabulatedShapeFamily class has been removed, with functionality moved to TabulatedGSDShapeFamily.

Added

• TabulatedGSDShapeFamilies are now iterable, allowing easier access to shapes.
• New UniformPrismFamily, UniformAntiprismFamily, UniformPyramidFamily, and UniformDipyramidFamily
• New documentation to help users initialize common geometries.
• New methods to export Polyhedra as OBJ, OFF, STL, PLY, VTK, X3D, and HTML files.

Changed

• The data in DOI_SHAPE_REPOSITORIES for source :cite:Damasceno2012 is now sorted to match the order described in the paper.

Deprecated

• The PrismAntiprismFamily and PyramidDipyramidFamily have been deprecated in favor of the new families added above, which are faster, more consistent, and present a simplified interface.
  The deprecated code was retained for backwards compatibility, but is no longer included in the documentation.

Release v0.8.0

Release v0.8.0 - 2023-02-21

Added

• New edge_lengths method.
• combine_simplices, find_simplex_equations, _find_face_centroids, find_coplanar_simplices, _find_face_centroids, and calculate_signed_volume methods for the ConvexPolyhedron class.
• simplices, equations, and face_centroids properties for the ConvexPolyhedron class.
• Additional pytests for surface area, volume, centroid, moment of inertia, and equations properties.
• New to_hoomd and to_json export methods for use with simulation tools

Changed

• Pre-commit now uses ruff instead of flake8, pydocstyle, pyupgrade and isort.
• CI now uses GitHub Actions.
• Docs ported to furo theme.
• Reimplemented find_equations, _volume, surface_area, centroid, _compute_inertia_tensor, rescale, and get_face_area methods for convex polyhedra using NumPy vectorized operations and polyhedron simplices.
• [breaking] ConvexPolyhedron._surface_triangulation now returns sorted simplices, rather than running polytri. This can change the order of vertices and/or triangles.
• [breaking] faces may return faces in a different order than previously. Faces are still sorted with sort_faces, and will still be ordered such that curl and divergence theorems work properly.
• volume, surface_area, and centroid properties now return stored values, rather than computing the quantity at each call.
• rescale now computes the centroid to ensure the correct value is available when centroid is called.
• Optimized pytest configurations for more efficient use of local and remote resources.

Release v0.7.0

Release v0.7.0 - 2023-09-18

Fixed

• Numerical precision issues in tests.
• GSD spec correctly outputs for Polyhedron objects.
• Error in __repr__ for polyhedra with multiple face degrees.
• ReadTheDocs build errors resulting from conda memory usage.

Changed

• The minimum required Python version is now 3.8.
• The minimum required NumPy version is now 1.19.
• [breaking] Sped up point in polygon and point in polyhedron using NumPy.
• Migrated to pyproject.toml.

Added

• New edges and edge_vectors properties for polyhedra.
• New shape families for Archimedean, Catalan, and Johnson shapes.
• New shape families for regular pyramids and dipyramids, and a selection of regular prisms and antiprisms.