VTKio 0.1.0.dev2__tar.gz

vtkio-0.1.0.dev2/.gitignore

@@ -0,0 +1,315 @@
+
+# Created by https://www.toptal.com/developers/gitignore/api/linux,python,windows,visualstudiocode,pycharm
+# Edit at https://www.toptal.com/developers/gitignore?templates=linux,python,windows,visualstudiocode,pycharm
+
+### Linux ###
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+### PyCharm ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# AWS User-specific
+.idea/**/aws.xml
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+ .idea/modules.xml
+# .idea/*.iml
+ .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# SonarLint plugin
+.idea/sonarlint/
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+### PyCharm Patch ###
+# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721
+
+# *.iml
+# modules.xml
+# .idea/misc.xml
+# *.ipr
+
+# Sonarlint plugin
+# https://plugins.jetbrains.com/plugin/7973-sonarlint
+.idea/**/sonarlint/
+
+# SonarQube Plugin
+# https://plugins.jetbrains.com/plugin/7238-sonarqube-community-plugin
+.idea/**/sonarIssues.xml
+
+# Markdown Navigator plugin
+# https://plugins.jetbrains.com/plugin/7896-markdown-navigator-enhanced
+.idea/**/markdown-navigator.xml
+.idea/**/markdown-navigator-enh.xml
+.idea/**/markdown-navigator/
+
+# Cache file creation bug
+# See https://youtrack.jetbrains.com/issue/JBR-2257
+.idea/$CACHE_FILE$
+
+# CodeStream plugin
+# https://plugins.jetbrains.com/plugin/12206-codestream
+.idea/codestream.xml
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Jupyter
+.ipynb_checkpoints/
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### VisualStudioCode ###
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!.vscode/*.code-snippets
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+### VisualStudioCode Patch ###
+# Ignore all local history of files
+.history
+.ionide
+
+### Windows ###
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+### Sync files ###
+*.ffs_db
+
+# End of https://www.gitignore.io/api/linux,python,windows,visualstudiocode
+.idea/.gitignore
+.idea/dictionaries
+.idea/inspectionProfiles/
+.idea/misc.xml
+.idea/modules.xml
+.idea/pyEDem.iml
+.idea/vcs.xml

vtkio-0.1.0.dev2/CITATION.cff

@@ -0,0 +1,30 @@
+# This CITATION.cff file was generated with cffinit.
+# Visit https://bit.ly/cffinit to generate yours today!
+
+cff-version: 1.2.0
+title: VTKio
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+type: software
+authors:
+  - given-names: 'John '
+    family-names: Morrissey
+    email: morrissey.jp@gmail.com
+    orcid: 'https://orcid.org/0000-0002-2389-8146'
+    affiliation: University of Edinburgh
+repository-code: 'https://www.github.com/vtkio'
+url: 'https://docs'
+abstract: >
+  VTKio is a python library for converting data between VTK
+  file formats (xml-based and hdf5-based) and numpy arrays.
+keywords:
+  - Python
+  - NumPy
+  - VTK
+  - XML
+  - HDF5
+  - VTKHDF
+license: BSD-3-Clause
+version: 0.1.0
+date-released: '2025-06-11'

vtkio-0.1.0.dev2/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.

vtkio-0.1.0.dev2/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,37 @@
+# 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)