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 (4628B)

      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 January 12, 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 ahsv
     29 .Op Fl l Ar lines
     30 .Op Fl m Ar molparam
     31 .Op Fl o Ar output
     32 .Op Fl z Ar compression_level
     33 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
     34 .Sh DESCRIPTION
     35 .Nm
     36 loads spectroscopic data formatted in HITRAN formats and displays
     37 informations about it.
     38 The data can be either isotopologue metadata or line-by-line parameters.
     39 In fact,
     40 .Nm
     41 is a utility for analyzing the behavior of the Star-HITRAN library with
     42 regard to the loading and its internal structuring of spectroscopic
     43 data.
     44 It can also be used to serialize the internal representation of loaded
     45 lines, which is much more compact and therefore faster to reload by the
     46 library.
     47 .Pp
     48 All isotopologue metadata are loaded.
     49 However, since the number of lines can be very large, only a subset of
     50 their parameters is actually loaded.
     51 The parameters loaded line-by-line are as follows:
     52 .Bl -dash -compact -offset Ds
     53 .It
     54 Central wavenumber in vacuum
     55 .It
     56 Reference intensity
     57 .It
     58 Air broadening half-width
     59 .It
     60 Self broadening half-width
     61 .It
     62 Lower state energy
     63 .It
     64 Temperature-dependant exponent
     65 .It
     66 Air-pressure wavenumber
     67 .El
     68 .Pp
     69 On output,
     70 .Nm
     71 displays the range of each parameter for all loaded lines, in addition
     72 to their encoding error once loaded, relative to the use of
     73 double-precision floating-point encoding.
     74 The total memory used is finally printed.
     75 .Pp
     76 The options are as follows:
     77 .Bl -tag -width Ds
     78 .It Fl a
     79 Measure line access performance.
     80 Both linear and random access are tested.
     81 .It Fl h
     82 Use suffixes to make memory usage easier to read: the number of
     83 consecutive digits is then three or less, using powers of 2 for sizes
     84 .Po
     85 KB = 1024, MB = 1048576, etc.
     86 .Pc .
     87 By default, memory usage is displayed in bytes.
     88 .It Fl l Ar lines
     89 Files storing line-by-line parameters to be loaded.
     90 .It Fl m Ar molparam
     91 Files storing isotopologue metadata to be loaded.
     92 .It Fl o Ar output
     93 Files in which to serialize the list of loaded lines.
     94 .It Fl s
     95 Input lines are formatted according to
     96 .Nm Ns 's
     97 internal format, not according to the HITRAN format
     98 .Po
     99 see the
    100 .Fl o
    101 option
    102 .Pc .
    103 .It Fl v
    104 Make
    105 .Nm
    106 verbose.
    107 Multiple
    108 .Fl v
    109 options increase the verbosity.
    110 The maximum is 3.
    111 .It Fl z Ar compression_level
    112 Line compression level.
    113 Must be between 0
    114 .Pq no compression
    115 and 9
    116 .Pq best compression .
    117 By default, uses an intermediate level that balances speed and
    118 compression.
    119 .El
    120 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    121 .Sh EXIT STATUS
    122 .Ex -std
    123 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    124 .Sh EXAMPLES
    125 Load a list of lines and serialize the resulting binary representation
    126 to the file
    127 .Pa CO2.bin .
    128 Make the output of
    129 .Nm
    130 as detailed as possible and use suffixes when displaying the size of
    131 memory used to make it easier to read:
    132 .Bd -literal -offset Ds
    133 shtr -l /path/to/CO2_lines.hitemp2010 -o CO2.bin -vvv -h
    134 .Ed
    135 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    136 .Sh SEE ALSO
    137 .Rs
    138 .%T The HITRAN Database
    139 .%U https://hitran.org/
    140 .Re
    141 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    142 .Sh STANDARDS
    143 .Rs
    144 .%A L.S. Rothman et al.
    145 .%T The HITRAN2012 molecular spectroscopic database
    146 .%J Journal of Quantitative Spectroscopy & Radiative Transfer
    147 .%V 130
    148 .%P pp. 4\(en50
    149 .%D 2013
    150 .Re
    151 .Pp
    152 .Rs
    153 .%A L.S. Rothman et al.
    154 .%T HITEMP, the high-temperature molecular spectroscopic database
    155 .%J Journal of Quantitative Spectroscopu & Radiative Transfer
    156 .%V 111
    157 .%P pp. 2139\(en2150
    158 .%D 2010
    159 .Re