star-mesh

Define and load a binary data format for meshes
git clone git://git.meso-star.fr/star-mesh.git
Log | Files | Refs | README | LICENSE

README.md (1670B)

      1 # Star-Mesh
      2 
      3 Star-Mesh loads surfacic or volumetric meshes saved in Star-Mesh file
      4 format. See smsh.5 for details.
      5 
      6 ## Requirements
      7 
      8 - C compiler
      9 - POSIX make
     10 - pkg-config
     11 - [RSys](https://gitlab.com/vaplv/rsys)
     12 - [mandoc](https://mandoc.bsd.lv)
     13 
     14 ## Installation
     15 
     16 Edit config.mk as needed, then run:
     17 
     18     make clean install
     19 
     20 ## Release notes
     21 
     22 ### Version 0.2
     23 
     24 - Add the smsh-desc utility.
     25   It prints the descriptor of a smsh file
     26 - Add the smsh2vtk utility.
     27   It converts triangular or tetrahedral meshes saved in smshs format to
     28   VTK (legacy) format.
     29 - Add the vtk-data utility.
     30   It formats a list of doubles as cell data in the legacy VTK format.
     31   It is then possible to attach data to a VTK mesh such as that produced
     32   by the smsh2vtk tool.
     33 - Improves the building system.
     34   Simplify it by doing everything in one place (the Makefile).
     35   Add macros to control installation subdirectories.
     36 
     37 ### Version 0.1
     38 
     39 - Make memory mapping optional.
     40   By default, data is now loaded into memory. Memory mapping becomes an
     41   option of the load functions, (forbidden on stdin).
     42 - Write the man page directly in mdoc's roff macros, instead of using
     43   the intermediate scdoc source.
     44 - Replace CMake by Makefile as build system.
     45 - Update compiler and linker flags to increase the security and
     46   robustness of generated binaries.
     47 - Provide a pkg-config file to link the library as an external
     48   dependency.
     49 
     50 ## License
     51 
     52 Copyright (C) 2020-2023, 2025 |Méso|Star> (contact@meso-star.com)
     53 
     54 Star-Mesh is free software released under the GPL v3+ license: GNU GPL
     55 version 3 or later. You are welcome to redistribute it under certain
     56 conditions; refer to the COPYING file for details.