star-hitran

Load line-by-line data from the HITRAN database
git clone git://git.meso-star.fr/star-hitran.git
Log | Files | Refs | README | LICENSE

shtr.1 (4665B)

      1 .\" Copyright (C) 2022, 2025, 2026 |Méso|Star> (contact@meso-star.com)
      2 .\" Copyright (C) 2025, 2026, Université de Lorraine
      3 .\" Copyright (C) 2022 Centre National de la Recherche Scientifique
      4 .\" Copyright (C) 2022 Université Paul Sabatier
      5 .\"
      6 .\" This program is free software: you can redistribute it and/or modify
      7 .\" it under the terms of the GNU General Public License as published by
      8 .\" the Free Software Foundation, either version 3 of the License, or
      9 .\" (at your option) any later version.
     10 .\"
     11 .\" This program is distributed in the hope that it will be useful,
     12 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
     13 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
     14 .\" GNU General Public License for more details.
     15 .\"
     16 .\" You should have received a copy of the GNU General Public License
     17 .\" along with this program. If not, see <http://www.gnu.org/licenses/>.
     18 .Dd February 11, 2026
     19 .Dt SHTR 1
     20 .Os
     21 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
     22 .Sh NAME
     23 .Nm shtr
     24 .Nd process spectroscopic data from HITRAN files
     25 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
     26 .Sh SYNOPSIS
     27 .Nm
     28 .Op Fl acHhisv
     29 .Op Fl l Ar lines
     30 .Op Fl m Ar molparam
     31 .Op Fl o Ar output
     32 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
     33 .Sh DESCRIPTION
     34 .Nm
     35 loads spectroscopic data formatted in HITRAN formats and displays
     36 informations about it.
     37 The data can be either isotopologue metadata or line-by-line parameters.
     38 In fact,
     39 .Nm
     40 is a utility for analyzing the behavior of the Star-HITRAN library with
     41 regard to the loading and its internal structuring of spectroscopic
     42 data.
     43 It can also be used to serialize the internal representation of loaded
     44 lines, which is much more compact and therefore faster to reload by the
     45 library.
     46 .Pp
     47 All isotopologue metadata are loaded.
     48 However, since the number of lines can be very large, only a subset of
     49 their parameters is actually loaded.
     50 The parameters loaded line-by-line are as follows:
     51 .Bl -dash -compact -offset Ds
     52 .It
     53 Central wavenumber in vacuum
     54 .It
     55 Reference intensity
     56 .It
     57 Air broadening half-width
     58 .It
     59 Self broadening half-width
     60 .It
     61 Lower state energy
     62 .It
     63 Temperature-dependant exponent
     64 .It
     65 Air-pressure wavenumber
     66 .El
     67 .Pp
     68 The options are as follows:
     69 .Bl -tag -width Ds
     70 .It Fl a
     71 Measure line access performance.
     72 Both linear and random access are tested.
     73 Performance is expressed in lines per second
     74 .Pq lps .
     75 .It Fl c
     76 Checks the validity of the parameters of the loaded lines, in terms of
     77 numerical values and definition domain.
     78 .It Fl H
     79 Use suffixes to make memory usage easier to read: the number of
     80 consecutive digits is then three or less, using powers of 2 for sizes
     81 .Po
     82 KB = 1024, MB = 1048576, etc.
     83 .Pc .
     84 By default, memory usage is displayed in bytes.
     85 .It Fl h
     86 Display short help and exit.
     87 .It Fl i
     88 Display information about loaded data, such as memory usage.
     89 For lines, the range of their parameters is also displayed, as well as
     90 their encoding error once loaded, relative to the use of
     91 double-precision floating-point encoding.
     92 .It Fl l Ar lines
     93 Files storing line-by-line parameters to be loaded.
     94 .It Fl m Ar molparam
     95 Files storing isotopologue metadata to be loaded.
     96 .It Fl o Ar output
     97 Files in which to serialize the list of loaded lines.
     98 .It Fl s
     99 Input lines are formatted according to
    100 .Nm Ns 's
    101 internal format, not according to the HITRAN format
    102 .Po
    103 see the
    104 .Fl o
    105 option
    106 .Pc .
    107 .It Fl v
    108 Make
    109 .Nm
    110 verbose.
    111 Multiple
    112 .Fl v
    113 options increase the verbosity.
    114 The maximum is 3.
    115 .El
    116 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    117 .Sh EXIT STATUS
    118 .Ex -std
    119 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    120 .Sh EXAMPLES
    121 Load a list of lines and serialize the resulting binary representation
    122 to the file
    123 .Pa CO2.bin .
    124 Make the output of
    125 .Nm
    126 as detailed as possible.
    127 Print information about loaded data and use suffixes when displaying the
    128 amount of memory used to make it easier to read:
    129 .Bd -literal -offset Ds
    130 shtr -l /path/to/CO2_lines.hitemp2010 -o CO2.bin -vvv -iH
    131 .Ed
    132 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    133 .Sh SEE ALSO
    134 .Rs
    135 .%T The HITRAN Database
    136 .%U https://hitran.org/
    137 .Re
    138 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    139 .Sh STANDARDS
    140 .Rs
    141 .%A L.S. Rothman et al.
    142 .%T The HITRAN2012 molecular spectroscopic database
    143 .%J Journal of Quantitative Spectroscopy & Radiative Transfer
    144 .%V 130
    145 .%P pp. 4\(en50
    146 .%D 2013
    147 .Re
    148 .Pp
    149 .Rs
    150 .%A L.S. Rothman et al.
    151 .%T HITEMP, the high-temperature molecular spectroscopic database
    152 .%J Journal of Quantitative Spectroscopu & Radiative Transfer
    153 .%V 111
    154 .%P pp. 2139\(en2150
    155 .%D 2010
    156 .Re