Skip to content

Add migration guide for FURY 0.12.x to v2.0.0 - #1302

Merged
skoudoro merged 5 commits into
fury-gl:masterfrom
medha-14:api_change
Aug 3, 2026
Merged

Add migration guide for FURY 0.12.x to v2.0.0#1302
skoudoro merged 5 commits into
fury-gl:masterfrom
medha-14:api_change

Conversation

@medha-14

Copy link
Copy Markdown
Collaborator

No description provided.

@maharshi-gor
maharshi-gor marked this pull request as ready for review July 31, 2026 15:44

@skoudoro skoudoro left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @medha-14 and @maharshi-gor,

See below some comments.
Also:

  • Renamed: peak_slicer→peaks_slicer, slicer→volume_slicer/data_slicer, markers→marker, dot→point, cube→box, odf_slicer→sph_glyph, text_3d/vector_text→text
  • Removed, no successor: tensor_slicer, sdf, grid, scalar_bar, figure, rectangle, texture/texture_2d/texture_on_sphere/texture_update, io.load_sprite_sheet
  • New modules absent from guide: fury.animation, fury.motion, fury.network, fury.geometry, fury.material, fury.shader; new io — read_mesh, read_points, read_lines, load_cube_map_texture, load_network/save_network
  • fury.window.record — gone, replaced by snapshot / record_animation. Not mentioned.

please, check all of that.

Thanks !

Comment thread docs/source/migration_guide_v2.0.rst Outdated

show_m.start() # blocking render loop
show_m.render() # non-blocking single-frame request
show_m.snapshot(fname) # save PNG of current frame

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

show_m.snapshot(fname=fname)

Comment thread docs/source/migration_guide_v2.0.rst Outdated

.. code-block:: python

fury.io.save_image(array, "output.tiff", compression_type="tiff_lzw")

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure tiff_lzw exists. use compression_type="lzw"

Comment thread docs/source/migration_guide_v2.0.rst Outdated

.. code-block:: python

import imgui

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

import imgui_bundle as imgui right ?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No from imgui_bundle import imgui

Comment thread docs/source/migration_guide_v2.0.rst Outdated
Comment on lines +453 to +457
**Action**: ``ComboBox2D``, ``ListBox2D``, ``TextBox2D``, and
``RangeSlider`` are available in master and require no replacement. Only
``DrawPanel`` and ``FileMenu2D`` remain unavailable; if you relied on
those, consider an ImGui panel as a temporary substitute until they are
ported.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

weird section and not aligned with the previous section above

Comment thread docs/source/migration_guide_v2.0.rst Outdated
Comment on lines +216 to +219
* - ``actor.streamlines``
- :ghpull:`1021`
* - ``actor.streamtube``
- Shader-based rewrite :ghpull:`1038`

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this and other below was existing before so sentence is wrong

Comment thread docs/source/migration_guide_v2.0.rst Outdated
- Removed
* - ``pygfx``
- Added (≥ 0.16.0)
* - ``wgpu``

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it is not a dependency... it come with pygfx. Correct ?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is both. In a sense we do import few things directly from wgpu but it is to avoid overheads of pygfx or to write something custom.

Comment thread docs/source/migration_guide_v2.0.rst
Comment thread docs/source/migration_guide_v2.0.rst Outdated


Dependency Changes
------------------

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use ~~~~~~~~~~~ instead, weird section otherwise

Comment thread docs/source/migration_guide_v2.0.rst
Comment thread docs/source/migration_guide_v2.0.rst Outdated

@skoudoro skoudoro left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for the update,

merging

@skoudoro
skoudoro merged commit b3eb9bf into fury-gl:master Aug 3, 2026
22 checks passed
@maharshi-gor maharshi-gor changed the title Add migration guide for FURY 0.13.x to v2.0.0 Add migration guide for FURY 0.12.x to v2.0.0 Aug 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants