Release 0.33.0

[akaszynski]

Proposing a release of pyvista==0.33.0.

First step is to bump our main branch version to pyvista==0.34.dev0 in this PR. Next step will be to bump the version in this branch to 0.33.0 and push a tag v0.33.0.

@pyvista/developers if there are any reservations, please let me know.

[codecov]

Codecov Report

Merging #1995 (4db5ee2) into main (48a25aa) will not change coverage.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main    #1995   +/-   ##
=======================================
  Coverage   93.11%   93.11%           
=======================================
  Files          74       74           
  Lines       15520    15520           
=======================================
  Hits        14451    14451           
  Misses       1069     1069           

[tkoyama010]

Now it is time to use "Automatically generated release notes" . @pyvista/developers Please check that all of your contribution PR have a correct label (See #1712).

[akaszynski]

Now it is time to use "Automatically generated release notes" . @pyvista/developers Please check that all of your contribution PR have a correct label (See #1712).

I'm looking forward to not having to manually generate the description. Thanks @tkoyama010!

[adeak]

Please check that all of your contribution PR have a correct label (See #1712).

@tkoyama010 thanks. What are the "correct" labels? And since when do we have to check PRs?

I'm looking forward to not having to manually generate the description.

@akaszynski will there be a preview for the release notes we can fine-tune if necessary?

[akaszynski]

@akaszynski will there be a preview for the release notes we can fine-tune if necessary?

As far as I can tell, there's no preview (I would have to create a tag first), but you should feel free to open an issue or edit the release notes directly.

Nevermind, you can just manually create a tag with the web interface. Here's what the release notes will look like:

---

What's Changed

New Features

• Add style parameter in text slider widgets by @GuillaumeFavelier in Add style parameter in text slider widgets #1093
• add subdivision option to extract_surface by @akaszynski in add subdivision option to extract_surface #1174
• Add Physically Based Rendering by @banesullivan in Add Physically Based Rendering #823
• Add legend face option by @tkoyama010 in Add legend face option #1496
• 🚩 Add progress_bar to filters/algorithms by @tkoyama010 in 🚩 Add progress_bar to filters/algorithms #1519
• Add methods of flip and scale by @tkoyama010 in Add methods of flip and scale #1569
• Add Kochanek Spline function by @tkoyama010 in Add Kochanek Spline function #1603
• Refactor silhouette from add_mesh by @MatthewFlamm in Refactor silhouette from add_mesh #1689
• add plot face normals by @akaszynski in add plot face normals #1686
• Add plotting cursor by @tkoyama010 in Add plotting cursor #1700
• Add find cells along line by @tkoyama010 in Add find cells along line #1704
• Add Platonic solids, clean Cube by default by @adeak in Add Platonic solids, clean Cube by default #1692
• Add find cells within bounds by @tkoyama010 in Add find cells within bounds #1710
• Add Tube function by @tkoyama010 in Add Tube function #1718
• Add enable_stereo_render() and disable_stereo_render() by @puripant in Add enable_stereo_render() and disable_stereo_render() #1722
• UnstructuredGrid add initialization from vtk.vtkPolyData object by @beppo-dd in UnstructuredGrid add initialization from vtk.vtkPolyData object #1756
• Binary pickling by @whophil in Binary pickling #1778
• Implement iadd for meshes by @adeak in Implement __iadd__ for meshes #1850
• Add support for vtkSuperquadric by @janniklasrose in Add support for vtkSuperquadric #1844
• add camera orientation widget by @akaszynski in add camera orientation widget #1899
• Support in-memeory screenshot by @banesullivan in Support in-memeory screenshot #1876
• Charts by @dcbr in Charts #1432
• add split sharp edges by @akaszynski in add split sharp edges #1685
• add manifold check by @akaszynski in add manifold check #1684
• refactor to warn on int usage by @akaszynski in refactor to warn on int usage #1964
• enforce consistent API by @akaszynski in enforce consistent API #1971

Bug fixes or behavior changes

• 🐛 Fix: sampling arc angle and resolution by @tkoyama010 in 🐛 Fix: sampling arc angle and resolution #1298
• Fix pythreejs warning by @dstansby in Fix pythreejs warning #1668
• Align vtkDataSetReader usage and add more ReadAll* calls by default by @MatthewFlamm in Align vtkDataSetReader usage and add more ReadAll* calls by default #1675
• implement copy on transform by @akaszynski in implement copy on transform #1688
• Fix find_closest_cell not finding closest cells by @MatthewFlamm in Fix find_closest_cell not finding closest cells #1740
• Fix race conditions in pyvista.init by @whophil in Fix race conditions in pyvista.__init__ #1794
• Add transparency and double side for pythreejs backend by @ssg-aero in Add transparency and double side for pythreejs backend #1836
• Fix PolyData inplace merge by @adeak in Fix PolyData inplace merge #1720
• Fix MultiBlock Slicing and equality by @MatthewFlamm in Fix MultiBlock Slicing and equality #1811
• Fix shrink filter output by @banesullivan in Fix shrink filter output #1863
• 🐛 DataSetAttribute should return string array by @tkoyama010 in 🐛 DataSetAttribute should return string array #1852
• Fix texture coordinates overwriting bug by @banesullivan in Fix texture coordinates overwriting bug #1873
• Remove O(n) searches triggering expensive equality testing in MultiBlock creation and lookups by @adeak in Remove O(n) searches triggering expensive equality testing in MultiBlock creation and lookups #1805
• Clarify camera distance by @dstansby in Clarify camera distance #1935
• Optionally run osmnx-example by @banesullivan in Optionally run osmnx-example #1867
• disable warning when using pythreejs backend by @akaszynski in disable warning when using pythreejs backend #1952
• ScalarBars.add_scalar_bar: correct annotation text scaling setting, when fixed font size is given by @beppo-dd in ScalarBars.add_scalar_bar: correct annotation text scaling setting, when fixed font size is given #1750
• Make sure inplace never defaults to True by @banesullivan in Make sure inplace never defaults to True #1860
• stop overwriting plot theme by @akaszynski in stop overwriting plot theme #1963
• Convert integer point and data arrays to float32 in transform() by @adeak in Convert integer point and data arrays to float32 in transform() #1968

Documentation

• DOC: Fix citation bibtex entry and spell out two authors by @adeak in DOC: Fix citation bibtex entry and spell out two authors #1292
• ➕ Fix import of example by @tkoyama010 in ➕ Fix import of example #1424
• ➕ Extra import fix of example by @tkoyama010 in ➕ Extra import fix of example #1425
• 📝 Add VesselVio to external gallery by @tkoyama010 in 📝 Add VesselVio to external gallery #1444
• 📝 Fix typo by @tkoyama010 in 📝 Fix typo #1458
• 🎬 Add Create a GIF Movie with updating textures by @tkoyama010 in 🎬 Add Create a GIF Movie with updating textures #1544
• Add codetriage badge by @tkoyama010 in Add codetriage badge #1587
• 👾 Add Alien Monsters example by @tkoyama010 in 👾 Add Alien Monsters example #1677
• add truss example by @akaszynski in add truss example #1683
• Add Plotter.add_volume example by @puripant in Add Plotter.add_volume example #1707
• Add examples for view_* functions by @puripant in Add examples for view_* functions #1714
• Fix resetting _wrappers in sphinx-gallery by @MatthewFlamm in Fix resetting _wrappers in sphinx-gallery #1721
• Add examples in plotting module by @AleenaSA in Add examples in plotting module #1715
• Automated PR: Update Local Intersphinx by @github-actions in Automated PR: Update Local Intersphinx #1767
• Add plot to glyphs example by @tkoyama010 in Add plot to glyphs example #1723
• Fix docstring examples with broken rendering by @adeak in Fix docstring examples with broken rendering #1770
• Fix find_closest_cell examples doctest by @MatthewFlamm in Fix find_closest_cell examples doctest #1809
• ✏️ Fix typo. by @tkoyama010 in ✏️ Fix typo. #1829
• ✏️ Fix typo. by @tkoyama010 in ✏️ Fix typo. #1842
• ✏️ Fix docstring by @tkoyama010 in ✏️ Fix docstring #1843
• Clean up the examples by @banesullivan in Clean up the examples #1851
• Add glyph's docstring and test by @tkoyama010 in Add glyph's docstring and test #1872
• Fix interpolate example by @banesullivan in Fix interpolate example #1881
• A thank you to @MatthewFlamm and @darikg by @banesullivan in A thank you to @MatthewFlamm and @darikg #1901
• Reset theme in sphinx gallery and reset before and after examples by @MatthewFlamm in Reset theme in sphinx gallery and reset before and after examples #1915
• 📝Update version of CODE_OF_CONDUCT. by @tkoyama010 in 📝Update version of CODE_OF_CONDUCT. #1916
• 📝Fix [INSERT CONTACT METHOD] by @tkoyama010 in 📝Fix [INSERT CONTACT METHOD] #1917
• Use custom VTK with OSMesa wheel to build the docs by @akaszynski in Use custom VTK with OSMesa wheel to build the docs #1942
• 📝 Add plot to show downloads datasets by @tkoyama010 in 📝 Add plot to show downloads datasets #1826
• Add make uniform grid class init more explicit by @akaszynski in Add make uniform grid class init more explicit #1783
• 🎉 HAPPY NEW YEAR 2022 🎉 by @tkoyama010 in 🎉 HAPPY NEW YEAR 2022 🎉 #1989
• 👷 Automate copyright date by @tkoyama010 in 👷 Automate copyright date #1991
• ✏️ Fix typos. by @tkoyama010 in ✏️ Fix typos. #1996

Maintenance

• Use larger infinity for orbit controls by @akaszynski in Use larger infinity for orbit controls #1657
• Add typing extensions dependency by @akaszynski in Add typing extensions dependency #1658
• Use built-in typing when possible by @MatthewFlamm in Use built-in typing when possible #1663
• clean parametric objects by default by @akaszynski in clean parametric objects by default #1676
• cleanup legend by @akaszynski in cleanup legend #1703
• Remove trailing white space and add CI check by @banesullivan in Remove trailing white space and add CI check #1865
• Major clean up to imports by @banesullivan in Major clean up to imports #1871
• Automated PR: Update Local Intersphinx by @github-actions in Automated PR: Update Local Intersphinx #1905
• FIX: Bump version by @larsoner in FIX: Bump version #1911
• Maintenance: add vtk 9.0.3 to CI by @MatthewFlamm in Maintenance: add vtk 9.0.3 to CI #1922
• make meshio an optional dependency by @nschloe in make meshio an optional dependency #1939
• move doc coverage to makefile and out of pipeline by @akaszynski in move doc coverage to makefile and out of pipeline #1954
• add meshio as a doc req by @akaszynski in add meshio as a doc req #1958
• Add support for meshio >=5.2 by @stefsmeets in Add support for meshio >=5.2 #1960
• add back in missing import by @akaszynski in add back in missing import #1962
• Use dependabot by @akaszynski in Use dependabot #1972
• fix codecov reporting by @akaszynski in fix codecov reporting #1969
• Partial revert of 1899 - Fix coverage by @akaszynski in Partial revert of 1899 - Fix coverage #1973
• 👷 Automate labeling in update intersphinx PR by @tkoyama010 in 👷 Automate labeling in update intersphinx PR #1992
• Automated PR: Update Local Intersphinx by @github-actions in Automated PR: Update Local Intersphinx #1990
• enforce positive coverage by @akaszynski in enforce positive coverage #1993

New Contributors

• @whophil made their first contribution in Fix UnstructuredGrid init from arrays for VTK 8.90 #1039
• @Sinaxist made their first contribution in Update background_image.py #1044
• @yngvem made their first contribution in Bugfix for #1053: Plotter.update fails with interactive_update=True if auto_close=False is not specified #1056
• @Boorhin made their first contribution in Update movie.py #1075
• @Spectre5 made their first contribution in fix typos in example code #1084
• @rodrigomologni made their first contribution in Fix "Hide points in add_point_labels is not working" #1092
• @sampotter made their first contribution in Add make_tri_mesh helper #1101
• @shakasaki made their first contribution in Fixed disk geometry to rotate and translate properly #1061
• @nickvazz made their first contribution in Add variable length density to voxelize #1100
• @d-chambers made their first contribution in fix typo #1154
• @RichardScottOZ made their first contribution in Update what-is-a-mesh.rst #1176
• @akeshavan made their first contribution in Small fix: Do not create a directory if PYVISTA_USERDATA_PATH is defined #1240
• @fgallardo-mpie made their first contribution in fix interpolation documentation #1346
• @hakostra made their first contribution in Disable warning on missing xserver also when using OSMesa #1372
• @AleenaSA made their first contribution in Add Plotter.add_text example #1640
• @github-actions made their first contribution in Automated PR: Update Local Intersphinx #1701
• @puripant made their first contribution in Add Plotter.add_volume example #1707
• @beppo-dd made their first contribution in UnstructuredGrid add initialization from vtk.vtkPolyData object #1756
• @ssg-aero made their first contribution in Add transparency and double side for pythreejs backend #1836
• @janniklasrose made their first contribution in Add support for vtkSuperquadric #1844
• @nschloe made their first contribution in make meshio an optional dependency #1939
• @stefsmeets made their first contribution in Add support for meshio >=5.2 #1960
• @p-j-smith made their first contribution in Ignore the window when picking points #1908

Full Changelog: 0.27.0...v0.33

[akaszynski]

Seems that release notes are generated based on the tag of that branch (main), which we've not done since v0.27 since all of our tags are on release branches. I'm going to have to figure out how to fix that.

[tkoyama010]

What are the "correct" labels? And since when do we have to check PRs?

@adeak The target PRs are those that have been released since the last release. I have labeled all the PRs, so please make sure that the labeling is correct.

• enhancement
• bug
• documentation
• maintenance

[akaszynski]

Seems that release notes are generated based on the tag of that branch (main), which we've not done since v0.27 since all of our tags are on release branches. I'm going to have to figure out how to fix that.

After creating several tags on main, I'm still not clear on what's causing the issue. There's a long discussion on this here. I'm going to do the lazy thing and delete anything release notes that's prior to the release of 0.32.0