.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "examples/03-updating-visor-scene/00-add-remove-dataset.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_examples_03-updating-visor-scene_00-add-remove-dataset.py>`
        to download the full example code.

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_examples_03-updating-visor-scene_00-add-remove-dataset.py:


.. _ref_add_remove_dataset:


Add and remove datasets
=======================

You can add and remove datasets from an existing VISOR scene without restarting the visualizer.

This example shows how to add a new dataset to an existing VISOR scene, list all
datasets in the scene, and remove an existing dataset by its ID.

.. GENERATED FROM PYTHON SOURCE LINES 14-46

.. code-block:: Python


    from ansys.visor.viewer import Visor

    # Set up example assets, which exist in the VISOR repository.
    # File 1 + Metadata 1
    input_file1 = "examples/assets/vtk_scene_sphere_l2_b3_r32_v3_c1_z0.vtm"
    metadata_file1 = "examples/assets/vtk_scene_sphere_l2_b3_r32_v3_c1_z0.json"
    # File 2 + Metadata 2
    input_file2 = "examples/assets/vtk_scene_sphere_l2_b3_r32_v3_c1_z3.vtm"
    metadata_file2 = "examples/assets/vtk_scene_sphere_l2_b3_r32_v3_c1_z3.json"


    # Start VISOR visualizer with an initial dataset
    visualizer = Visor()
    visualizer.start(input=input_file1, metadata=metadata_file1)

    # Add a dataset to the existing scene
    print(f"Adding dataset: {input_file2} with metadata: {metadata_file2}")
    visualizer.add_dataset(input="new_dataset.vtu", metadata="new_metadata.json")

    # List all datasets in the current scene
    datasets = visualizer.list_datasets() # returns a dictionary keyed by dataset IDs
    print(f"Current datasets in the scene: {datasets}")

    # Remove one of the datasets
    dataset_id = list(datasets.keys())[0] # Get the first dataset ID

    # Remove a dataset by its ID (assuming the ID is known, such as 1)
    print(f"Removing dataset with ID: {dataset_id}")
    visualizer.remove_dataset(dataset_id=dataset_id)

    # Stop the visualizer
    visualizer.stop()

.. _sphx_glr_download_examples_03-updating-visor-scene_00-add-remove-dataset.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: 00-add-remove-dataset.ipynb <00-add-remove-dataset.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: 00-add-remove-dataset.py <00-add-remove-dataset.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: 00-add-remove-dataset.zip <00-add-remove-dataset.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_