VTKio 0.1.0.dev2__py3-none-any.whl

vtkio-0.1.0.dev2.dist-info/METADATA

@@ -0,0 +1,86 @@
+Metadata-Version: 2.4
+Name: VTKio
+Version: 0.1.0.dev2
+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
+Project-URL: Issues, https://gitlab.com/jpmorr/vtkio/-/issues
+Project-URL: Source, https://gitlab.com/jpmorr/vtkio/-/tree/main
+Project-URL: Changelog, https://gitlab.com/jpmorr/vtkio/-/tree/main
+Project-URL: donate, https://ko-fi.com/jpmorr
+Author-email: JP Morrissey <morrissey.jp@gmail.com>
+Maintainer-email: JP Morrissey <morrissey.jp@gmail.com>
+License-Expression: BSD-3-Clause
+License-File: LICENSE
+Keywords: Converter,HDF5,NumPy,VTK,Visualisation,XML
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Manufacturing
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Requires-Python: >=3.10
+Requires-Dist: dotwiz>=0.4.0
+Requires-Dist: h5py>=3.11
+Requires-Dist: numpy>=2.1
+Requires-Dist: pybase64>=1.3
+Requires-Dist: xmltodict>=0.13
+Provides-Extra: docs
+Requires-Dist: markdown-exec[ansi]>=1.10.3; extra == 'docs'
+Requires-Dist: mkdocs-autorefs>=1.4.2; extra == 'docs'
+Requires-Dist: mkdocs-git-committers-plugin-2>=2.5.0; extra == 'docs'
+Requires-Dist: mkdocs-git-revision-date-localized-plugin>=1.4.7; extra == 'docs'
+Requires-Dist: mkdocs-material-extensions>=1.3.1; extra == 'docs'
+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'
+Provides-Extra: tests
+Requires-Dist: pytest-cov>=6.1.1; extra == 'tests'
+Requires-Dist: pytest>=8.3.5; extra == 'tests'
+Description-Content-Type: text/markdown
+
+# VTKio
+A simple python package for reading and writing Visualization Tool Kit (VTK) files.
+![](https://img.shields.io/badge/Python-3776AB?style=flat&logo=python&logoColor=white)
+
+
+## Supported features
+Legacy ascii `.vtk` files are not supported and only the newer XML and HDF% based formats are supported.
+
+XML files can be written in `ascii`, `base64` binary and appended `base64` binary formats. 
+The means all files remain valid `XML` documents.
+
+XML and VTKHDF files can also be read using the associated file readers. 
+
+Data is returned in appropriate VTK classes with arrays stored in `numpy` formats. 
+
+> [!WARNING]
+> VTKHDF files can only be opened in supported software. For example, ParaView has full VTKHDF 
+> support in  5.13 and above.
+
+
+## VTK File Formats
+All file formats have been developed based on VTK's [documentation](https://docs.vtk.org/en/latest/index.html) where 
+the [XML](https://docs.vtk.org/en/latest/design_documents/VTKFileFormats.html#xml-file-formats) formats and newer
+[VTKHDF](https://docs.vtk.org/en/latest/design_documents/VTKFileFormats.html#vtkhdf-file-format) formats are described in detail.
+Additional information can be found in [Chapter 5](https://book.vtk.org/en/latest/VTKBook/05Chapter5.html#) of the **VTK Book**.
+
+Further information regarding the VTK data model can be found in the [ParaView documentation](https://docs.paraview.org/en/latest/UsersGuide/understandingData.html#vtk-data-model).
+
+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).
+
+For full documentation visit [jpmorr.gitlab.io](https://jpmorr.gitlab.io/vtkio).
+
+## Related packages
+
+ - [PyEVTK](https://github.com/paulo-herrera/PyEVTK)
+ - [meshio](https://github.com/nschloe/meshio)
+ - [uvw](https://github.com/prs513rosewood/uvw)

vtkio-0.1.0.dev2.dist-info/RECORD

@@ -0,0 +1,20 @@
+vtkio/__init__.py,sha256=mvaycVi5qmGoaGD45qkShKxoDAr1CSadkluBM-O72dY,520
+vtkio/_git.py,sha256=jG8rTkhiZ8M0D8tGaYzfiV86mvqKWKRTFnVrT525Bbs,1055
+vtkio/helpers.py,sha256=PXMUaRLY7MlWsV91r-_jORXsc3uBZRfMgkccyxadodk,2589
+vtkio/simplified.py,sha256=qRffaU2vO1obEmj8mVJrxtU4BBcAD43UZGiSq_poj4I,29653
+vtkio/utilities.py,sha256=_1f3pQWW_NeJzGJSVB4kbQJHBypmfx32F5GD07--qTg,7010
+vtkio/version.py,sha256=F9eedgAbQ0u6Jll6B9iaHWIHl4bOvFZo356HH01tXuI,2041
+vtkio/vtk_cell_types.py,sha256=yJcEfQT3bgDzqESQu-A7HTMqgLjLIeI2Uez9YswYR80,4320
+vtkio/vtk_structures.py,sha256=-pn0o_XgX6aP-nOERCBRjllKf8N4V1CoocUhmHi6MTY,9467
+vtkio/reader/__init__.py,sha256=YkKmnhaRd85iVxbl66rIfuuF6uJ6PSP42whJ4Hdt4HE,305
+vtkio/reader/hdf5.py,sha256=9mthhFCwlCwOyI6VqKwW_Ce_rdOHfBmuK4RJAJkSLq4,12872
+vtkio/reader/xml.py,sha256=s9m0dtqLVSgotBaM96RZhvpPJZxaAMiXG-CnQ-pbs10,26655
+vtkio/writer/__init__.py,sha256=5fgtre23Sqxku6zECf8mJy95rxN6_GnrcB0d6xerw90,338
+vtkio/writer/pvd_writer.py,sha256=3YUvZW4aJs7K89ZxeYDeA3nmWUsxC6sdXmKgBIYe8bk,3494
+vtkio/writer/vtkhdf.py,sha256=LbC1HCjegKKv_H8tooHtnKr_DrwqSMd-oRfMFz67518,56881
+vtkio/writer/writers.py,sha256=bqu62AofT5e6V2eL-Pc4f8QgDg03U_uS882AG-tvjDM,18735
+vtkio/writer/xml_writer.py,sha256=oQl3cIxrywwRFCdPrlHs_JP4tiAN0I202DpAv1P-fi8,59981
+vtkio-0.1.0.dev2.dist-info/METADATA,sha256=xTCJYhDcQtkXXU2Gkp5hfLLXiHeW2jU356znxDfh5KI,4165
+vtkio-0.1.0.dev2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+vtkio-0.1.0.dev2.dist-info/licenses/LICENSE,sha256=2Q5OODW8zpcArqMHz_8hTAMmyGDUVvR52US4UkgPbiY,1533
+vtkio-0.1.0.dev2.dist-info/RECORD,,

vtkio-0.1.0.dev2.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

vtkio-0.1.0.dev2.dist-info/licenses/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2021-2025, John Paul Morrissey. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.