Science Score: 54.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
✓Academic publication links
Links to: zenodo.org -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (15.0%) to scientific vocabulary
Keywords
Repository
Julia package for writing VTK XML files
Basic Info
Statistics
- Stars: 157
- Watchers: 10
- Forks: 33
- Open Issues: 13
- Releases: 0
Topics
Metadata Files
README.md
WriteVTK.jl
This package allows to write VTK XML files for visualisation of multidimensional datasets using tools such as ParaView. A wide range of VTK formats is supported, including different kinds of structured and unstructured grids, as well as metadata files for describing time series or multi-block domains.
Installation
WriteVTK can be installed using the Julia package manager:
julia
julia> ] add WriteVTK
Quick start
The vtk_grid function is the entry point for creating different kinds
of VTK files.
In the simplest cases, one just passes coordinate information to this function.
WriteVTK.jl then determines the VTK format that is more adapted for the provided
data.
For instance, it is natural in Julia to describe a uniform three-dimensional grid (with regularly-spaced increments) as a set of ranges:
julia
x = 0:0.1:1
y = 0:0.2:1
z = -1:0.05:1
This specific way of specifying coordinates is compatible with the image data
VTK format, which has the .vti extension.
The following creates such a file, with some scalar data attached to each point:
julia
vtk_grid("fields", x, y, z) do vtk
vtk["temperature"] = rand(length(x), length(y), length(z))
end
This will create a fields.vti file with the data.
Note that the file extension should not be included in the filename, as it will
be attached automatically according to the dataset type.
By changing the coordinate specifications, the above can be naturally generalised to non-uniform grid spacings and to curvilinear and unstructured grids. In each case, the correct kind of VTK file will be generated.
Supported VTK formats
This package attempts to implement writers for all VTK XML formats described in the VTK specification. Note that legacy (non-XML) files are not supported.
Supported dataset formats include:
- image data (.vti),
- rectilinear grid (.vtr),
- structured (or curvilinear) grid (.vts),
- unstructured grid (.vtu),
- polydata (.vtp, a specific type of unstructured grid).
Moreover, the following metadata formats are supported:
- multiblock files (.vtm),
- ParaView collections (.pvd, typically used for time series),
- parallel files (.pvt*).
Further reading
See the documentation for more details on how to use this package.
Authors
This package is mainly written and maintained by Juan Ignacio Polanco, with many important contributions by Fredrik Ekre. Moreover, a number of authors have implemented additional functionality, and are acknowledged throughout the documentation.
Owner
- Name: JuliaVTK
- Login: JuliaVTK
- Kind: organization
- Repositories: 2
- Profile: https://github.com/JuliaVTK
Julia interface to VTK
Citation (CITATION.cff)
cff-version: 1.1.0
message: "If you use this software, please cite it as below."
authors:
- family-names: Polanco
given-names: Juan Ignacio
affiliation: CNRS, Univ. Grenoble Alpes, Laboratory of Geophysical and Industrial Flows (LEGI)
orcid: https://orcid.org/0000-0001-7705-753X
website: https://jipolanco.gitlab.io
title: 'WriteVTK.jl: a Julia package for writing VTK XML files'
version: 1.10.1
doi: 10.5281/zenodo.3722891
date-released: 2021-07-04
repository-code: https://github.com/JuliaVTK/WriteVTK.jl
license: MIT
GitHub Events
Total
- Create event: 3
- Commit comment event: 1
- Release event: 1
- Issues event: 5
- Watch event: 7
- Delete event: 1
- Issue comment event: 18
- Push event: 11
- Pull request event: 5
- Fork event: 2
Last Year
- Create event: 3
- Commit comment event: 1
- Release event: 1
- Issues event: 5
- Watch event: 7
- Delete event: 1
- Issue comment event: 18
- Push event: 11
- Pull request event: 5
- Fork event: 2
Packages
- Total packages: 1
-
Total downloads:
- julia 1,205 total
- Total dependent packages: 50
- Total dependent repositories: 11
- Total versions: 53
juliahub.com: WriteVTK
Julia package for writing VTK XML files
- Documentation: https://docs.juliahub.com/General/WriteVTK/stable/
- License: MIT
-
Latest release: 1.21.2
published 11 months ago
Rankings
Dependencies
- JuliaRegistries/TagBot v1 composite
- actions/checkout v3 composite
- codecov/codecov-action v3 composite
- julia-actions/cache v1 composite
- julia-actions/julia-buildpkg v1 composite
- julia-actions/julia-processcoverage v1 composite
- julia-actions/julia-runtest v1 composite
- julia-actions/setup-julia v1 composite
- julia-actions/setup-julia latest composite