rngrd

Describe a surface and its physical properties
git clone git://git.meso-star.com/rngrd.git
Log | Files | Refs | README | LICENSE

rngrd-lint.1 (3791B)

      1 .\" Copyright (C) 2022, 2023, 2025 Centre National de la Recherche Scientifique
      2 .\" Copyright (C) 2022, 2023, 2025 Institut Pierre-Simon Laplace
      3 .\" Copyright (C) 2022, 2023, 2025 Institut de Physique du Globe de Paris
      4 .\" Copyright (C) 2022, 2023, 2025, 2026 |Méso|Star>(contact@meso-star.com)
      5 .\" Copyright (C) 2022, 2023, 2025 Observatoire de Paris
      6 .\" Copyright (C) 2022, 2023, 2025 Université de Reims Champagne-Ardenne
      7 .\" Copyright (C) 2022, 2023, 2025 Université de Versaille Saint-Quentin
      8 .\" Copyright (C) 2022, 2023, 2025 Université Paul Sabatier
      9 .\"
     10 .\" This program is free software: you can redistribute it and/or modify
     11 .\" it under the terms of the GNU General Public License as published by
     12 .\" the Free Software Foundation, either version 3 of the License, or
     13 .\" (at your option) any later version.
     14 .\"
     15 .\" This program is distributed in the hope that it will be useful,
     16 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
     17 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
     18 .\" GNU General Public License for more details.
     19 .\"
     20 .\" You should have received a copy of the GNU General Public License
     21 .\" along with this program. If not, see <http://www.gnu.org/licenses/>.
     22 .Dd May 25, 2026
     23 .Dt RNGRD-LINT 1
     24 .Os
     25 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
     26 .Sh NAME
     27 .Nm rngrd-lint
     28 .Nd check the loading and structuring of a decorated mesh
     29 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
     30 .Sh SYNOPSIS
     31 .Nm
     32 .Op Fl hVv
     33 .Fl M Ar material_list
     34 .Fl m Ar geometry
     35 .Fl p Ar properties
     36 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
     37 .Sh DESCRIPTION
     38 .Nm
     39 checks the data used to define a triangular mesh, to which a temperature
     40 and a spectrally varying Bidirectional Reflectance Distribution Function
     41 .Pq BRDF
     42 are associated for each triangle.
     43 .Pp
     44 This utility effectively validates the behavior of the Rad-Net GRouD
     45 library
     46 .Pq RNGRD
     47 regarding the loading and internal structuring of this data.
     48 Its purpose is therefore to verify that the input data is valid and
     49 conforms to the library's expectations prior to running another program
     50 that relies on the same library and is intended to process the same
     51 data.
     52 .Pp
     53 The options are as follows:
     54 .Bl -tag -width Ds
     55 .\""""""""""""""""""""""""""""""""""
     56 .It Fl h
     57 Display short help and exit.
     58 .\""""""""""""""""""""""""""""""""""
     59 .It Fl M Ar material_list
     60 File that lists all the materials used by the geometry.
     61 It is a text file in
     62 .Xr rnsl 5
     63 format, where each line specifies the path to a material file in
     64 .Xr mrumtl 5
     65 format.
     66 .\""""""""""""""""""""""""""""""""""
     67 .It Fl m Ar mesh
     68 File that stores triangular mesh data in the
     69 .Xr smsh 5
     70 format.
     71 .\""""""""""""""""""""""""""""""""""
     72 .It Fl p Ar properties
     73 File that defines triangle properties in
     74 .Xr rnsp 5
     75 format.
     76 .\""""""""""""""""""""""""""""""""""
     77 .It Fl V
     78 Perform more thorough validation tests, such as checking all surface
     79 properties to verify that they match the mesh they are associated with
     80 and the list of loaded materials.
     81 .\""""""""""""""""""""""""""""""""""
     82 .It Fl v
     83 Make the program verbose.
     84 .El
     85 .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
     86 .Sh EXIT STATUS
     87 .Ex -std
     88 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
     89 .Sh EXAMPLES
     90 Verify the loading and structure of the triangular mesh geometry
     91 .Pa geom.smsh
     92 as well as its triangle-specific properties in
     93 .Pa props.rnsp .
     94 The materials referenced in the
     95 .Pa props.rnsp
     96 file are listed in the text file
     97 .Pa mat.rnsl .
     98 Perform a thorough validation of the loaded data
     99 .Pq option Fl V
    100 and make the command verbose
    101 .Pq option Fl v
    102 to obtain more information than just its return code:
    103 .Bd -literal -offset Ds
    104 rngrd-lint -m geom.smsh -p props.rnsp -M mat.rnsl -Vv
    105 .Ed