Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/build-and-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,9 @@ jobs:
- name: Build sdist
run: pipx run build --sdist

- name: Verify README renders on PyPI (twine check)
run: pipx run twine check --strict dist/*.tar.gz

- name: Install sdist
run: pip install dist/*.tar.gz

Expand Down
11 changes: 5 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,9 @@ PyVista accessor (recommended, ``pyvista >= 0.48``)
===================================================

Installing ``pyacvd`` registers an ``acvd`` namespace on every
:class:`pyvista.PolyData`, so uniform remeshing slots straight into a
PyVista pipeline. Once ``pyacvd`` is imported (or auto-discovered via
PyVista's entry-point system) you can call ``mesh.acvd.<method>(...)``
directly:
``pyvista.PolyData``, so uniform remeshing slots straight into a PyVista
pipeline. Once ``pyacvd`` is imported (or auto-discovered via PyVista's
entry-point system) you can call ``mesh.acvd.<method>(...)`` directly:

.. code:: python

Expand All @@ -51,8 +50,8 @@ The accessor never mutates the source mesh and always returns a fresh
one-shot uniform remesh.

- ``mesh.acvd.clustering(weights=None, subdivide=0)`` — return a
configured :class:`pyacvd.Clustering` for fine-grained control
(plotting clusters, mixing fast/uniform clustering, etc.).
configured ``pyacvd.Clustering`` for fine-grained control (plotting
clusters, mixing fast/uniform clustering, etc.).

- ``mesh.acvd.cluster_ids(n_clusters, ...)`` — per-point cluster id
array, useful for visualization.
Expand Down
Loading