Skip to content

Commit

Permalink
Links now point to JuliaVTK organisation (#122)
Browse files Browse the repository at this point in the history
This affects mainly the docs and the README.md file.
  • Loading branch information
jipolanco authored Mar 31, 2023
1 parent d3ec971 commit c4339a9
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 21 deletions.
4 changes: 2 additions & 2 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ message: "If you use this software, please cite it as below."
authors:
- family-names: Polanco
given-names: Juan Ignacio
affiliation: Univ Lyon, CNRS, École Centrale de Lyon, LMFA
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/jipolanco/WriteVTK.jl
repository-code: https://github.com/JuliaVTK/WriteVTK.jl
license: MIT
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# WriteVTK.jl

[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://jipolanco.github.io/WriteVTK.jl/stable/)
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://jipolanco.github.io/WriteVTK.jl/dev/)
[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliavtk.github.io/WriteVTK.jl/stable/)
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://juliavtk.github.io/WriteVTK.jl/dev/)
[![DOI](https://zenodo.org/badge/32700186.svg)](https://zenodo.org/badge/latestdoi/32700186)

[![Build Status](https://github.com/jipolanco/WriteVTK.jl/workflows/CI/badge.svg)](https://github.com/jipolanco/WriteVTK.jl/actions)
[![Coverage](https://codecov.io/gh/jipolanco/WriteVTK.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/jipolanco/WriteVTK.jl)
[![Build Status](https://github.com/JuliaVTK/WriteVTK.jl/workflows/CI/badge.svg)](https://github.com/JuliaVTK/WriteVTK.jl/actions)
[![Coverage](https://codecov.io/gh/JuliaVTK/WriteVTK.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JuliaVTK/WriteVTK.jl)

This package allows to write VTK XML files for visualisation of multidimensional
datasets using tools such as [ParaView](http://www.paraview.org/).
Expand Down Expand Up @@ -38,7 +38,7 @@ y = 0:0.2:1
z = -1:0.05:1
```

This specific way of specifying coordinates is compatible with the [image data](https://jipolanco.github.io/WriteVTK.jl/dev/grids/structured/#Image-data)
This specific way of specifying coordinates is compatible with the [image data](https://juliavtk.github.io/WriteVTK.jl/dev/grids/structured/#Image-data)
VTK format, which has the `.vti` extension.
The following creates such a file, with some scalar data attached to each point:

Expand All @@ -64,20 +64,20 @@ the [VTK specification](http://www.vtk.org/VTK/img/file-formats.pdf).
Note that legacy (non-XML) files are not supported.

Supported dataset formats include:
- [image data](https://jipolanco.github.io/WriteVTK.jl/dev/grids/structured/#Image-data) (`.vti`),
- [rectilinear grid](https://jipolanco.github.io/WriteVTK.jl/dev/grids/structured/#Rectilinear-grid) (`.vtr`),
- [structured (or curvilinear) grid](https://jipolanco.github.io/WriteVTK.jl/dev/grids/structured/#Structured-grid) (`.vts`),
- [unstructured grid](https://jipolanco.github.io/WriteVTK.jl/dev/grids/unstructured/#Unstructured-grid) (`.vtu`),
- [polydata](https://jipolanco.github.io/WriteVTK.jl/dev/grids/unstructured/#Polydata-grid) (`.vtp`, a specific type of unstructured grid).
- [image data](https://juliavtk.github.io/WriteVTK.jl/dev/grids/structured/#Image-data) (`.vti`),
- [rectilinear grid](https://juliavtk.github.io/WriteVTK.jl/dev/grids/structured/#Rectilinear-grid) (`.vtr`),
- [structured (or curvilinear) grid](https://juliavtk.github.io/WriteVTK.jl/dev/grids/structured/#Structured-grid) (`.vts`),
- [unstructured grid](https://juliavtk.github.io/WriteVTK.jl/dev/grids/unstructured/#Unstructured-grid) (`.vtu`),
- [polydata](https://juliavtk.github.io/WriteVTK.jl/dev/grids/unstructured/#Polydata-grid) (`.vtp`, a specific type of unstructured grid).

Moreover, the following metadata formats are supported:
- [multiblock files](https://jipolanco.github.io/WriteVTK.jl/dev/metadata/multiblock/) (`.vtm`),
- [ParaView collections](https://jipolanco.github.io/WriteVTK.jl/dev/metadata/paraview_collections/) (`.pvd`, typically used for time series),
- [parallel files](https://jipolanco.github.io/WriteVTK.jl/dev/metadata/parallel/) (`.pvt*`).
- [multiblock files](https://juliavtk.github.io/WriteVTK.jl/dev/metadata/multiblock/) (`.vtm`),
- [ParaView collections](https://juliavtk.github.io/WriteVTK.jl/dev/metadata/paraview_collections/) (`.pvd`, typically used for time series),
- [parallel files](https://juliavtk.github.io/WriteVTK.jl/dev/metadata/parallel/) (`.pvt*`).

## Further reading

See [the documentation](https://jipolanco.github.io/WriteVTK.jl/stable/) for more details on how to use this package.
See [the documentation](https://juliavtk.github.io/WriteVTK.jl/stable/) for more details on how to use this package.

## Authors

Expand Down
8 changes: 4 additions & 4 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ DocMeta.setdocmeta!(

makedocs(;
modules = [WriteVTK],
authors = "Juan Ignacio Polanco <[email protected]> and contributors",
repo = "https://github.com/jipolanco/WriteVTK.jl/blob/{commit}{path}#L{line}",
authors = "Juan Ignacio Polanco <[email protected]> and contributors",
repo = "https://github.com/JuliaVTK/WriteVTK.jl/blob/{commit}{path}#L{line}",
sitename = "WriteVTK.jl",
format = Documenter.HTML(;
prettyurls = get(ENV, "CI", "false") == "true",
canonical = "https://jipolanco.github.io/WriteVTK.jl",
canonical = "https://juliavtk.github.io/WriteVTK.jl",
assets = [
"assets/tomate.js",
],
Expand Down Expand Up @@ -46,6 +46,6 @@ makedocs(;
)

deploydocs(;
repo = "github.com/jipolanco/WriteVTK.jl.git",
repo = "github.com/JuliaVTK/WriteVTK.jl.git",
forcepush = true,
)
2 changes: 1 addition & 1 deletion docs/src/grids/unstructured.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ WriteVTK also supports the creation of unstructured VTK files containing [polyhe
The specificity of polyhedron cells is that they require the specification not only of a connectivity vector, but also of a list of faces constituting the polyhedron.
To specify a polyhedron cell, instead of using the [`MeshCell`](@ref) type, one should create an instance of [`VTKPolyhedron`](@ref).

The following simple example creates a cube as a polyhedron cell (see also [`test/polyhedron_cube.jl`](https://github.com/jipolanco/WriteVTK.jl/blob/master/test/polyhedron_cube.jl) for an example with two cubes):
The following simple example creates a cube as a polyhedron cell (see also [`test/polyhedron_cube.jl`](https://github.com/JuliaVTK/WriteVTK.jl/blob/master/test/polyhedron_cube.jl) for an example with two cubes):

```julia
# Vertices of the cube
Expand Down

0 comments on commit c4339a9

Please sign in to comment.