commit c527bd5aa2466abd6a6a02958c42c5158c9dd364
parent 932e1f85006bd6384d4443a1b2b1a76800a9d05a
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Fri, 16 May 2025 17:14:05 +0200
Add smeteo file format manual page
Diffstat:
| M | Makefile | | | 1 | + |
| A | doc/smeteo.5 | | | 100 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
2 files changed, 101 insertions(+), 0 deletions(-)
diff --git a/Makefile b/Makefile
@@ -131,6 +131,7 @@ uninstall:
lint:
mandoc -T lint -Wbase doc/smeteo.1 || [ $$? -le 1 ]
+ mandoc -T lint -Wbase doc/smeteo.5 || [ $$? -le 1 ]
clean: clean_test
rm -f $(DEP) $(OBJ) $(LIBNAME)
diff --git a/doc/smeteo.5 b/doc/smeteo.5
@@ -0,0 +1,100 @@
+.\" Copyright (C) 2025 |Méso|Star> (contact@meso-star.com)
+.\"
+.\" This program is free software: you can redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as published by
+.\" the Free Software Foundation, either version 3 of the License, or
+.\" (at your option) any later version.
+.\"
+.\" This program is distributed in the hope that it will be useful,
+.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+.\" GNU Lesser General Public License for more details.
+.\"
+.\" You should have received a copy of the GNU Lesser General Public License
+.\" along with this program. If not, see <http://www.gnu.org/licenses/>.
+.Dd May 16, 2025
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Dt SMETEO 5
+.Os
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh NAME
+.Nm smeteo
+.Nd file format for time varying meteorological data
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh DESCRIPTION
+A
+.Nm
+file stores meteorological data in plain text.
+Each line contains a set of meteorological data for a given date.
+Lines should be sorted in ascending date order.
+.Pp
+Empty lines are ignored, as are comments, which are strings beginning with the
+sharp character
+.Pq Li # .
+.Pp
+The grammar of the file format is presented below in a Backus-Naur form.
+A description ending in a backslash
+.Pq Li \e
+means that the line does not end, but the rest of its content is given on the
+next grammatical line for the convenience of formatting this manual.
+Text introduced by the sharp character
+.Pq Li #
+in descriptions is a comment and does not form part of the description.
+They are used to provide additional information.
+.Pp
+The file format is as follows:
+.Bl -column (data-set) (::=) ()
+.It Ao Va smeteo Ac Ta ::= Ta Ao Va data-set Ac
+.It Ta Ta ...
+.It Ao Va data-set Ac Ta ::= Ta
+.Aq Va date
+.Aq Va Tsrf
+.Aq Va Tatm
+.Aq Va SWdn
+.Aq Va SWup
+\e
+.It Ta Ta
+.Aq Va Trad
+.Aq Va h
+.Aq Va LE
+.Aq Va day/1850
+.It \ Ta Ta
+.It Ao Va date Ac Ta ::= Ta
+.Ao Va day Ac Ns - Ns
+.Ao Va month Ac Ns - Ns
+.Ao Va year Ac
+.Ao Va hour Ac : Ns
+.Ao Va minute Ac : Ns
+.Ao Va second Ac
+.It Ao Va day Ac Ta ::= Ta Va integer No # Bo 01, Ns 31 Bc
+.It Ao Va month Ac Ta ::= Ta
+\& \&
+.Li Jan |
+.Li Feb |
+.Li Mar |
+.Li Apr |
+.Li May |
+.Li Jun
+.It Ta Ta
+|
+.Li Jul |
+.Li Aug |
+.Li Sep |
+.Li Oct |
+.Li Nov |
+.Li Dec
+.It Ao Va year Ac Ta ::= Ta Va integer
+.It Ao Va hour Ac Ta ::= Ta Va integer No # Bo 0, Ns 23 Bc
+.It Ao Va minute Ac Ta ::= Ta Va integer No # Bo 00, Ns 59 Bc
+.It Ao Va second Ac Ta ::= Ta Va integer No # Bo 00, Ns 59 Bc
+.It \ Ta Ta
+.It Ao Va Tsrf Ac Ta ::= Ta Va real No # Surface temperature >0 [K]
+.It Ao Va Tatm Ac Ta ::= Ta Va real No # Atmosphere temperature >0 [K]
+.It Ao Va SWdn Ac Ta ::= Ta Va real No # ShortWave downward flux [W.m^2]
+.It Ao Va SWup Ac Ta ::= Ta Va real No # ShortWave upward flux [W.m^2]
+.It Ao Va Trad Ac Ta ::= Ta Va real No # Radiative temperature >0 [K]
+.It Ao Va h Ac Ta ::= Ta Va real No # Convective coefficent >0 [W/K/m^2]
+.It Ao Va LE Ac Ta ::= Ta Va real No # Latent flux >0 [W/m^2]
+.It Ao Va day/1850 Ac Ta ::= Ta Va real
+# Time in fraction of day since 1 Jan 1850
+.El
