Skip to content

Commit 51da744

Browse files
committed
chore(release): v2.0.7
1 parent 64f1c61 commit 51da744

File tree

2 files changed

+40
-26
lines changed

2 files changed

+40
-26
lines changed

README.md

Lines changed: 39 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,20 @@
11
# VTKFortran
22

3-
**Pure Fortran VTK XML API** — a pure Fortran 2003+ OOP library for writing and reading files conforming the [VTK](http://www.vtk.org/) XML standard.
3+
>#### Pure Fortran VTK XML API
4+
>a pure Fortran 2003+ OOP library for writing and reading files conforming the [VTK](http://www.vtk.org/) XML standard.
45
5-
[![CI](https://github.com/szaghi/VTKFortran/actions/workflows/ci.yml/badge.svg)](https://github.com/szaghi/VTKFortran/actions)
6-
[![Coverage](https://img.shields.io/codecov/c/github/szaghi/VTKFortran.svg)](https://app.codecov.io/gh/szaghi/VTKFortran)
7-
[![GitHub tag](https://img.shields.io/github/tag/szaghi/VTKFortran.svg)](https://github.com/szaghi/VTKFortran/releases)
6+
[![GitHub tag](https://img.shields.io/github/v/tag/szaghi/VTKFortran)](https://github.com/szaghi/VTKFortran/tags)
7+
[![GitHub issues](https://img.shields.io/github/issues/szaghi/VTKFortran)](https://github.com/szaghi/VTKFortran/issues)
8+
[![CI](https://github.com/szaghi/VTKFortran/actions/workflows/ci.yml/badge.svg)](https://github.com/szaghi/VTKFortran/actions/workflows/ci.yml)
9+
[![coverage](https://img.shields.io/endpoint?url=https://szaghi.github.io/VTKFortran/coverage.json)](https://github.com/szaghi/VTKFortran/actions/workflows/ci.yml)
810
[![License](https://img.shields.io/badge/license-GPLv3%20%7C%20BSD%20%7C%20MIT-blue.svg)](#copyrights)
911

10-
---
11-
12-
## Features
12+
| 📐 **VTK Topologies**<br>Rectilinear (`.vtr`), Structured (`.vts`), and Unstructured (`.vtu`) grids; composite multi-block (`.vtm`) and parallel partitioned (`.pvts`) datasets | 🗜️ **Output Formats**<br>ASCII, Base64-encoded binary, and raw binary appended |**Parallel Safe**<br>Thread and processor safe — multiple files can be written concurrently under OpenMP or MPI | 🎨 **OOP Design**<br>Polymorphic `xml_writer` allocated at runtime; `vtk_file`, `pvtk_file`, `vtm_file` expose a clean type-bound-procedure API |
13+
|:---:|:---:|:---:|:---:|
14+
| 🔢 **All Numeric Kinds**<br>All PENF kinds (`I1P``I8P`, `R4P``R8P`) and array ranks 1–4 supported in data arrays |**Error Codes**<br>Every procedure returns an integer error code — zero means success | 🔓 **Multi-licensed**<br>GPL v3 · BSD 2/3-Clause · MIT | 📦 **Multiple build systems**<br>CMake, FoBiS.py, fpm, Make |
1315

14-
- Write Rectilinear, Structured, and Unstructured grids in the VTK XML format
15-
- Composite multi-block datasets (`.vtm`) and parallel partitioned files (`.pvts`) supported
16-
- Output formats: ASCII, binary (Base64-encoded), and raw binary appended
17-
- Thread and processor safe — multiple files can be written concurrently under OpenMP or MPI
18-
- OOP design — polymorphic `xml_writer` allocated at runtime; `vtk_file`, `pvtk_file`, `vtm_file` types expose a clean type-bound-procedure API
19-
- All procedures return an integer error code — zero means success
20-
21-
**[Documentation](https://szaghi.github.io/VTKFortran/)** | **[API Reference](https://szaghi.github.io/VTKFortran/api/)**
16+
>#### [Documentation](https://szaghi.github.io/VTKFortran/)
17+
> For full documentation (guide, API reference, usage examples, etc.) see the [VTKFortran website](https://szaghi.github.io/VTKFortran/).
2218
2319
---
2420

@@ -41,8 +37,6 @@ This project is distributed under a multi-licensing system:
4137

4238
## Quick start
4339

44-
Write a structured grid in binary XML format:
45-
4640
```fortran
4741
use vtk_fortran, only : vtk_file
4842
use penf, only : I4P, R8P
@@ -68,28 +62,48 @@ error = a_vtk_file%xml_writer%write_piece()
6862
error = a_vtk_file%finalize()
6963
```
7064

65+
See [`src/tests/`](src/tests/) for more examples covering rectilinear, unstructured, multi-block, parallel, and volatile XML output.
66+
7167
---
7268

7369
## Install
7470

75-
### Clone and build with CMake
71+
### CMake
72+
73+
**Clone, build, and test:**
7674

77-
```sh
75+
```bash
7876
git clone https://github.com/szaghi/VTKFortran --recursive
7977
cd VTKFortran
8078
cmake -S . -B build -DBUILD_TESTING=ON
8179
cmake --build build && ctest --test-dir build
8280
```
8381

84-
### CMake subdirectory integration
82+
**As a subdirectory dependency** — place a recursive clone alongside your sources and add to your `CMakeLists.txt`:
8583

8684
```cmake
8785
add_subdirectory(VTKFortran)
8886
target_link_libraries(your_target VTKFortran::VTKFortran)
8987
```
9088

91-
| Tool | Command |
92-
|------|---------|
93-
| CMake | `cmake -S . -B build && cmake --build build` |
94-
| FoBiS.py | `FoBiS.py build -mode static-gnu` |
95-
| FPM | `fpm build` |
89+
### FoBiS.py
90+
91+
```bash
92+
git clone https://github.com/szaghi/VTKFortran --recursive && cd VTKFortran
93+
FoBiS.py build -mode static-gnu # static library
94+
FoBiS.py build -mode tests-gnu # build and place tests in ./exe/
95+
bash scripts/run_tests.sh # run tests
96+
```
97+
98+
### fpm
99+
100+
```bash
101+
fpm build
102+
fpm test
103+
```
104+
105+
### GNU Make
106+
107+
```bash
108+
make
109+
```

VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
v2.0.6
1+
v2.0.7

0 commit comments

Comments
 (0)