VTKio 0.1.0.dev3__tar.gz → 0.1.0.dev4__tar.gz

{vtkio-0.1.0.dev3 → vtkio-0.1.0.dev4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: VTKio
-Version: 0.1.0.dev3
+Version: 0.1.0.dev4
 Summary: A simple package for converting data between VTK files (XML and HDF5) and NumPy arrays.
 Project-URL: Homepage, https://jpmorr.gitlab.io/vtkio
 Project-URL: Documentation, https://jpmorr.gitlab.io/vtkio
@@ -42,6 +42,7 @@ Requires-Dist: mkdocs-material[imaging]>=9.6.14; extra == 'docs'
 Requires-Dist: mkdocs>=1.6.1; extra == 'docs'
 Requires-Dist: mkdocstrings-python>=0.18; extra == 'docs'
 Requires-Dist: mkdocstrings>=0.29.1; extra == 'docs'
+Requires-Dist: pipdeptree; extra == 'docs'
 Provides-Extra: tests
 Requires-Dist: pytest-cov>=6.1.1; extra == 'tests'
 Requires-Dist: pytest>=8.3.5; extra == 'tests'
@@ -66,7 +67,7 @@ Data is returned in appropriate VTK classes with arrays stored in `numpy` format
 
 > [!WARNING]
 > VTKHDF files can only be opened in supported software.  
-> For example, ParaView has full VTKHDF support in  5.13 and above.
+> For example, ParaView has full VTKHDF support in 5.13 and above.
 
 
 ## VTK File Formats
@@ -79,7 +80,7 @@ Further information regarding the VTK data model can be found in the [ParaView d
 Example datafiles can be found for various filetypes at the [VTK Examples Repository](https://gitlab.kitware.com/vtk/vtk-examples/-/tree/master/src/Testing/Data?ref_type=heads).
 
 ## Documentation
-For full documentation visit [jpmorr.gitlab.io](https://jpmorr.gitlab.io/vtkio).
+For full documentation visit [jpmorr.gitlab.io/vtkio](https://jpmorr.gitlab.io/vtkio).
 
 ## Related packages
 The following packages have some overlap in functionality with VTKio: 

{vtkio-0.1.0.dev3 → vtkio-0.1.0.dev4}/README.md

@@ -17,7 +17,7 @@ Data is returned in appropriate VTK classes with arrays stored in `numpy` format
 
 > [!WARNING]
 > VTKHDF files can only be opened in supported software.  
-> For example, ParaView has full VTKHDF support in  5.13 and above.
+> For example, ParaView has full VTKHDF support in 5.13 and above.
 
 
 ## VTK File Formats
@@ -30,7 +30,7 @@ Further information regarding the VTK data model can be found in the [ParaView d
 Example datafiles can be found for various filetypes at the [VTK Examples Repository](https://gitlab.kitware.com/vtk/vtk-examples/-/tree/master/src/Testing/Data?ref_type=heads).
 
 ## Documentation
-For full documentation visit [jpmorr.gitlab.io](https://jpmorr.gitlab.io/vtkio).
+For full documentation visit [jpmorr.gitlab.io/vtkio](https://jpmorr.gitlab.io/vtkio).
 
 ## Related packages
 The following packages have some overlap in functionality with VTKio: 

{vtkio-0.1.0.dev3 → vtkio-0.1.0.dev4}/examples/ImageData.py

@@ -238,7 +238,7 @@ imagedata_test.write_vtkhdf_file()
 # spacing = [0.1, 0.1, 0.1]
 # direction = [1, 0, 0, 0, 1, 0, 0, 0, 1]
 
-write_vti('test_uniform_image_data_2', whole_extent, origin+0.7312, spacing*0.45,
+write_vti('test_uniform_image_data_2', whole_extent, origin=origin+0.7312, spacing=spacing*0.45,
                  cell_data={"scalars": {"pressure": pressure}}, point_data=point_data, field_data=field_data)
 
 #%% VTKHDFImageDataWriter example
@@ -248,3 +248,20 @@ imagedata_test = VTKHDFImageDataWriter('test_image_data_grid_hdf5_new', whole_ex
 
 imagedata_test.write_vtkhdf_file()
 
+
+#%% write vtkhdf file with additional metadata
+from vtkio.reader import read_vtkxml_data
+
+regular_grid_example_data = read_vtkxml_data('../TestData/vti/regular_grid_example.vti')
+structured_points_data = read_vtkxml_data('../TestData/vti/structured_points.vti')
+vase_data = read_vtkxml_data('../TestData/vti/vase.vti')
+
+# --8<-- [start:write_points_writer_api_vtkhdf_additional_metadata]
+from vtkio.writer.vtkhdf import VTKHDFMultiBlockWriter
+
+blocks = {'block1': regular_grid_example_data, 'block2': structured_points_data, 'block3': vase_data,}
+
+writer = VTKHDFMultiBlockWriter('hdf_multiblock_test_imagedata', blocks)
+writer.write_vtkhdf_file()
+
+# --8<-- [end:write_points_writer_api_vtkhdf_additional_metadata]

{vtkio-0.1.0.dev3 → vtkio-0.1.0.dev4}/examples/PolyData.py

@@ -18,11 +18,8 @@ __status__ = 'Development'
 import numpy as np
 
 # Local Sources
-from vtkio.reader import read_data
-from vtkio.simplified import lines_to_poly, points_to_poly, polylines_to_poly
+from vtkio.reader import read_vtkxml_data
 from vtkio.writer.writers import write_vtp
-from vtkio.writer.xml_writer import vtk_multiblock_writer
-from vtkio.writer.vtkhdf import VTKHDFPolyDataWriter
 
 write_vtp('test_blank_vtp', points=None, lines=None, verts=None, point_data=None,
          cell_data=None, field_data=None, encoding='ascii')
@@ -209,11 +206,11 @@ points_to_poly('polytest_base64', points, data=point_data,
 # --8<-- [end:write_points_helper]
 
 #%% test hdf5 polydata
-plate_data = read_data('../TestData/vtp/plate_vectors.vtp')
-map_data = read_data('../TestData/vtp/map.vtp')
-poly_verts_data = read_data('../TestData/vtp/polytest.vtp')
-lines_data = read_data('../TestData/vtp/ibm_with_data.vtp')
-cow_data = read_data('../TestData/vtp/cow.vtp')
+plate_data = read_vtkxml_data('../TestData/vtp/plate_vectors.vtp')
+map_data = read_vtkxml_data('../TestData/vtp/map.vtp')
+poly_verts_data = read_vtkxml_data('../TestData/vtp/polytest.vtp')
+lines_data = read_vtkxml_data('../TestData/vtp/ibm_with_data.vtp')
+cow_data = read_vtkxml_data('../TestData/vtp/cow.vtp')
 
 write_vtp('plate_vectors', points=plate_data.points,
           polys=(plate_data.polys.connectivity, plate_data.polys.offsets),
@@ -226,7 +223,7 @@ write_vtp('cow2', points=cow_data.points,
 write_vtp('map', points=map_data.points,
           lines=(map_data.lines.connectivity, map_data.lines.offsets),
           cell_data={"vectors": map_data.cell_data},
-          field_data=fielddata)
+          field_data=fielddata, encoding='binary')
 
 write_vtp('polytest', points=poly_verts_data.points,
           verts=(poly_verts_data.verts.connectivity, poly_verts_data.verts.offsets),
@@ -238,6 +235,11 @@ write_vtp('ibm_with_data', points=lines_data.points,
           point_data={"vectors": lines_data.point_data},
           field_data=fielddata)
 
+write_vtp('map', points=map_data.points,
+          lines=(map_data.lines.connectivity, map_data.lines.offsets),
+          cell_data={"vectors": map_data.cell_data},
+          field_data=fielddata, file_format='vtkhdf')
+
 #%% test vtkhdf writer class
 
 
@@ -393,9 +395,9 @@ polylines_to_poly('polyline_test_base64', points, pointsPerLine,
 #%% test writing multiblock files
 
 # --8<-- [start:write_poly_multiblock_xml]
-from vtkio.writer.xml_writer import vtk_multiblock_writer
+from vtkio.writer.xml_writer import xml_multiblock_writer
 
-vtk_multiblock_writer('new_vtk_multiblock_file', {
+xml_multiblock_writer('new_vtk_multiblock_file', {
     'Base': {'files': ['edem_cube_base_t_0.vtp']},
     'Sides': {'files':['edem_cube_back_wall_t_0.vtp', 'edem_cube_left_wall_t_0.vtp',
               'edem_cube_front_wall_t_0.vtp', 'edem_cube_right_wall_t_0.vtp'],
@@ -410,6 +412,7 @@ vtk_multiblock_writer('new_vtk_multiblock_file', {
 from vtkio.writer.vtkhdf import VTKHDFMultiBlockWriter
 
 blocks = {'block1': plate_data, 'block2': map_data, 'block3': cow_data, 'block4': lines_data}
-VTKHDFMultiBlockWriter('hdf_multiblock_test', blocks)
+writer = VTKHDFMultiBlockWriter('hdf_multiblock_test', blocks)
+writer.write_vtkhdf_file()
 
 # --8<-- [end:write_poly_multiblock_vtkhdf]

{vtkio-0.1.0.dev3 → vtkio-0.1.0.dev4}/examples/UnstructuredGrid.py

@@ -379,3 +379,23 @@ test = VTKHDFUnstructuredGridWriter('revolution_triangular_mesh_test_new_hdf5',
 test.write_vtkhdf_file()
 
 # --8<-- [end:write_points_writer_api_vtkhdf_additional_metadata]
+
+#%% write vtkhdf file with additional metadata
+from vtkio.reader import read_vtkxml_data
+
+cube_tensors_data = read_vtkxml_data('../TestData/vtu/cube_tensors.vtu')
+disc_quads_data = read_vtkxml_data('../TestData/vtu/disc_quads.vtu')
+fire_data = read_vtkxml_data('../TestData/vtu/fire.vtu')
+single_plane_data = read_vtkxml_data('../TestData/vtu/single_plane.vtu')
+multiple_tetra_data = read_vtkxml_data('../TestData/vtu/multiple_tetra.vtu')
+
+# --8<-- [start:write_points_writer_api_vtkhdf_additional_metadata]
+from vtkio.writer.vtkhdf import VTKHDFMultiBlockWriter
+
+blocks = {'block1': cube_tensors_data, 'block2': disc_quads_data, 'block3': fire_data,
+          'block4': single_plane_data,'block5': multiple_tetra_data,}
+
+writer = VTKHDFMultiBlockWriter('hdf_multiblock_test_unstructured', blocks)
+writer.write_vtkhdf_file()
+
+# --8<-- [end:write_points_writer_api_vtkhdf_additional_metadata]