| Name | VTKio JSON |
| Version |
0.1.0.dev7
JSON |
| download |
| home_page | None |
| Summary | A simple package for converting data between VTK files (XML and HDF5) and NumPy arrays. |
| upload_time | 2025-09-01 15:19:09 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
converter
hdf5
numpy
vtk
visualisation
xml
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# VTKio
A simple python package for reading and writing Visualization Tool Kit (VTK) files.
## Supported features
Legacy ascii `.vtk` files are not supported and only the newer **XML** and **HDF5** based formats are supported.
XML files can be written in `ascii`, `base64` binary and appended `base64` binary formats.
This means all files remain valid `XML` documents.
Support for reading and writing `raw` appended data is provided, but discouraged.
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).
## Documentation
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:
- [PyEVTK](https://github.com/paulo-herrera/PyEVTK)
- [meshio](https://github.com/nschloe/meshio)
- [uvw](https://github.com/prs513rosewood/uvw)
- [vtk-hdf](https://github.com/jmag722/vtk-hdf)
Raw data
{
"_id": null,
"home_page": null,
"name": "VTKio",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "JP Morrissey <morrissey.jp@gmail.com>",
"keywords": "Converter, HDF5, NumPy, VTK, Visualisation, XML",
"author": null,
"author_email": "JP Morrissey <morrissey.jp@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/2c/5f/88de624cf90028062b5fb18d0c3b9bee8b1a772539b9c85bd7895558c633/vtkio-0.1.0.dev7.tar.gz",
"platform": null,
"description": "# VTKio\n \nA simple python package for reading and writing Visualization Tool Kit (VTK) files.\n\n\n\n## Supported features\nLegacy ascii `.vtk` files are not supported and only the newer **XML** and **HDF5** based formats are supported.\n\nXML files can be written in `ascii`, `base64` binary and appended `base64` binary formats. \nThis means all files remain valid `XML` documents. \nSupport for reading and writing `raw` appended data is provided, but discouraged.\n\nXML and VTKHDF files can also be read using the associated file readers. \n\nData is returned in appropriate VTK classes with arrays stored in `numpy` formats. \n\n> [!WARNING]\n> VTKHDF files can only be opened in supported software. \n> For example, ParaView has full VTKHDF support in 5.13 and above.\n\n\n## VTK File Formats\nAll file formats have been developed based on VTK's [documentation](https://docs.vtk.org/en/latest/index.html) where \nthe [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.\nAdditional information can be found in [Chapter 5](https://book.vtk.org/en/latest/VTKBook/05Chapter5.html#) of the **VTK Book**.\n\nFurther 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).\n\nExample 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).\n\n## Documentation\nFor full documentation visit [jpmorr.gitlab.io/vtkio](https://jpmorr.gitlab.io/vtkio).\n\n## Related packages\nThe following packages have some overlap in functionality with VTKio: \n - [PyEVTK](https://github.com/paulo-herrera/PyEVTK)\n - [meshio](https://github.com/nschloe/meshio)\n - [uvw](https://github.com/prs513rosewood/uvw)\n - [vtk-hdf](https://github.com/jmag722/vtk-hdf)",
"bugtrack_url": null,
"license": null,
"summary": "A simple package for converting data between VTK files (XML and HDF5) and NumPy arrays.",
"version": "0.1.0.dev7",
"project_urls": {
"Changelog": "https://gitlab.com/jpmorr/vtkio/-/tree/main",
"Documentation": "https://jpmorr.gitlab.io/vtkio",
"Homepage": "https://jpmorr.gitlab.io/vtkio",
"Issues": "https://gitlab.com/jpmorr/vtkio/-/issues",
"Source": "https://gitlab.com/jpmorr/vtkio/-/tree/main",
"donate": "https://ko-fi.com/jpmorr"
},
"split_keywords": [
"converter",
" hdf5",
" numpy",
" vtk",
" visualisation",
" xml"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "3ed56401d4289372761058116d7f2277248f7fb77d6f6905ad8f0a6b2b4f9d91",
"md5": "f51458393707df68cadb6e97774101a1",
"sha256": "82d86897302d2ac18e105c5a331bf1a79a5875c8e79a426252fb5b2d242793d4"
},
"downloads": -1,
"filename": "vtkio-0.1.0.dev7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f51458393707df68cadb6e97774101a1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 57488,
"upload_time": "2025-09-01T15:19:08",
"upload_time_iso_8601": "2025-09-01T15:19:08.326191Z",
"url": "https://files.pythonhosted.org/packages/3e/d5/6401d4289372761058116d7f2277248f7fb77d6f6905ad8f0a6b2b4f9d91/vtkio-0.1.0.dev7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "2c5f88de624cf90028062b5fb18d0c3b9bee8b1a772539b9c85bd7895558c633",
"md5": "50a82e9703642712a6190030e6264bce",
"sha256": "b26800e8e9e319f177b63801716001562ae2cfbe16fb57394ed832fecad81032"
},
"downloads": -1,
"filename": "vtkio-0.1.0.dev7.tar.gz",
"has_sig": false,
"md5_digest": "50a82e9703642712a6190030e6264bce",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 89622,
"upload_time": "2025-09-01T15:19:09",
"upload_time_iso_8601": "2025-09-01T15:19:09.479525Z",
"url": "https://files.pythonhosted.org/packages/2c/5f/88de624cf90028062b5fb18d0c3b9bee8b1a772539b9c85bd7895558c633/vtkio-0.1.0.dev7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-01 15:19:09",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "jpmorr",
"gitlab_project": "vtkio",
"lcname": "vtkio"
}
