sln-stat.1 (5799B)
1 .\" Copyright (C) 2022, 2026 |Méso|Star> (contact@meso-star.com) 2 .\" Copyright (C) 2026 Université de Lorraine 3 .\" Copyright (C) 2022 Centre National de la Recherche Scientifique 4 .\" Copyright (C) 2022 Université Paul Sabatier 5 .\" 6 .\" This file is part of Star-Line. 7 .\" 8 .\" This program is free software: you can redistribute it and/or modify 9 .\" it under the terms of the GNU General Public License as published by 10 .\" the Free Software Foundation, either version 3 of the License, or 11 .\" (at your option) any later version. 12 .\" 13 .\" This program is distributed in the hope that it will be useful, 14 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of 15 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 .\" GNU General Public License for more details. 17 .\" 18 .\" You should have received a copy of the GNU General Public License 19 .\" along with this program. If not, see <http://www.gnu.org/licenses/>. 20 .Dd May 5, 2026 21 .Dt SLN-STAT 1 22 .Os 23 .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" 24 .Sh NAME 25 .Nm sln-stat 26 .Nd computations of basic statistics over k spectrum 27 .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" 28 .Sh SYNOPSIS 29 .Nm 30 .Op Fl dhsv 31 .Op Fl n Ar nrealisations 32 .Op Fl t Ar threads 33 .Fl S Ar nu_min , Ns Ar nu_max 34 .Fl a Ar accel_struct 35 .Fl m Ar molparams 36 .Fl l Ar lines 37 .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" 38 .Sh DESCRIPTION 39 .Nm 40 calculates the mean and mean of squares of k absorption values using a Monte 41 Carlo algorithm that samples the spectral lines that make up the gas mixture. 42 These computations are accelerated by sampling the lines based on the magnitude 43 of their contribution to the mixture’s spectrum, so that few Monte Carlo runs 44 are required to estimate the spectrum statistics with a high degree of 45 confidence. 46 The core of the proposal rests on this sampling strategy, made possible 47 by constructing an acceleration structure from the set of lines in the 48 mixture. 49 A structure built using the 50 .Xr sln-build 1 51 utility and provided as input to the program. 52 .Pp 53 The output of 54 .Nm 55 displays the estimated mean and mean of squares, their standard 56 deviation, and the number of Monte Carlo realisations rejected due to 57 issues encountered during the computation, such as numerical 58 uncertainty. 59 Each estimate is displayed on a line formatted as follows: 60 .Bd -literal -offset Ds 61 "%-16s: %e +/- %e; %lu\en", name, estimate, std_err, rejects_count 62 .Ed 63 .Pp 64 The options are as follows: 65 .Bl -tag -width Ds 66 .\"""""""""""""""""""""""""""""""""" 67 .It Fl a Ar accel_struct 68 An acceleration structure corresponding to the input 69 .Ar lines , 70 used to accelerate their sampling based on their importance. 71 This structure is generated by the 72 .Xr sln-build 1 73 tool. 74 .\"""""""""""""""""""""""""""""""""" 75 .It Fl d 76 Disables verification of the correspondence between the lines provided 77 by the 78 .Fl l 79 option and those used to construct 80 the acceleration structure defined by the 81 .Fl a 82 option. 83 .Pp 84 Warning! 85 It is always recommended to verify that the data is correct, even though 86 this verification can take a significant amount of time when there are a 87 large number of lines. 88 Anyway, a user who is 89 .Em certain 90 of the data’s consistency may nevertheless use this option 91 .Pq at their own risk 92 to disable this verification and thus speed up the execution. 93 .\"""""""""""""""""""""""""""""""""" 94 .It Fl h 95 Display short help and exit. 96 .It Fl l Ar lines 97 List of lines from which the tree was built. 98 This list is in binary format as generated by the 99 .Xr shtr 1 100 binary, or in plain text HITRAN format, depending on whether the 101 .Fl s 102 option is set or not, respectively. 103 .\"""""""""""""""""""""""""""""""""" 104 .It Fl m Ar molparams 105 Isotopologue metadata in HITRAN format. 106 .\"""""""""""""""""""""""""""""""""" 107 .It Fl n Ar nrealisations 108 Number of Monte Carlo realisations. 109 By default the number of realisations is 10000. 110 .\"""""""""""""""""""""""""""""""""" 111 .It Fl S Ar nu_min , Ns Ar nu_max 112 The spectral range, in cm^-1, over which the computations are performed. 113 The default spectral range is from 0 to infinity. 114 .\"""""""""""""""""""""""""""""""""" 115 .It Fl s 116 Specifies that input lines are formatted according to the binary format 117 as written by the 118 .Xr shtr 1 119 utility, and not according to the HITRAN format. 120 This format is more compact, allowing for faster loading of line data. 121 .\"""""""""""""""""""""""""""""""""" 122 .It Fl t Ar threads 123 Advice on the number of threads to use. 124 By default, 125 .Nm 126 uses as many threads as processor cores. 127 .\"""""""""""""""""""""""""""""""""" 128 .It Fl v 129 Make 130 .Nm 131 verbose. 132 Multiple 133 .Fl v 134 options increase the verbosity. 135 The maximum is 3. 136 .El 137 .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" 138 .Sh EXIT STATUS 139 .Ex -std 140 .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" 141 .Sh EXAMPLES 142 Estimate the mean k and mean square k between 100 and 2500 cm^-1 143 for a gaz mixture made of H2O, CO2 and CO molecules. 144 The thermodynamic properties of the mixture, such as its pressure, 145 temperature and molecular concentrations, correspond to those used to 146 construct the acceleration structures with sln-build, provided as input 147 arguments 148 .Pq option Fl a . 149 The isotopic metadata 150 .Pq option Fl m 151 and the list of lines 152 .Pq option Fl l 153 partitioned by the acceleration structure, complete the list of input 154 data. 155 The latter is encoded in the format generated by the 156 .Xr shtr 1 157 tool 158 .Pq option Fl s . 159 The isotopes are in HITRAN format. 160 Finally, make the program as verbose as possible 161 .Pq options Fl vvv . 162 .Bd -literal -offset Ds 163 sln-stat -S 100,2500 -a tree_H2O_CO2_CO_1atm_600K.sln \e 164 -m molparam.txt -sl H2O_CO2_CO_100-2500cm-1.shtr -vvv 165 .Ed 166 .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" 167 .Sh SEE ALSO 168 .Xr shtr 1 , 169 .Xr sln-build 1 , 170 .Xr sln-slab 1