Skip to content

Commit

Permalink
doc: apply table fix from jothepro/doxygen-awesome-css#88 (comment)
Browse files Browse the repository at this point in the history
  • Loading branch information
@MuellerSeb
MuellerSeb committed Oct 2, 2022
1 parent 43f80f7 commit 028a2bf
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 42 deletions.
4 changes: 1 addition & 3 deletions doc/1-main.dox
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,9 +97,8 @@ describe the evolution of the state variables at a given location

where

<CENTER>
|<b>Variable</b> |<b>Description</b> |
| :--------------------- | :-------------------------------------------------------- |
| ---------------------- | --------------------------------------------------------- |
|<b>Inputs</b>||
|\f$P\f$ | Daily precipitation depth, \f$\mathrm{mm}\; \mathrm{d}^{-1}\f$
|\f$E_p\f$ | Daily potential evapotranspiration (PET), \f$\mathrm{mm}\; \mathrm{d}^{-1}\f$
Expand Down Expand Up @@ -134,7 +133,6 @@ where
|\f$l\f$ | Index denoting a root zone horizon, \f$l=1,\ldots,L\f$ (say \f$L=3\f$), in the first layer, \f$0 \leq z \leq z_1\f$
|\f$t\f$ | Time index for each \f$\Delta t\f$ interval
|\f$\rho^l\f$ | Overall influx fraction accounting for the impervious cover within a cell
</CENTER>


\section mpr The Multiscale Parameter Regionalization Technique
Expand Down
74 changes: 37 additions & 37 deletions doc/3-data_preparation.dox
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@ air temperature, using the Hargreaves-Samani method.

The two meteorological variables which are needed:

<CENTER>

<b> Name | Unit | Temporal resolution </b>
| :------------------------- | :------------------------- | :------------------------- |
| -------------------------- | -------------------------- | -------------------------- |
Precipitation | \f$\mathrm{mm}\f$ | hourly to daily
Average air temperature | \f$^\circ \mathrm{C}\f$ | hourly to daily
</CENTER>



Dependent of the specification for the potential evapotranspiration (processCase(5)) additional
Expand All @@ -37,17 +37,17 @@ meteorological variables may be need:
\li processCase(5) = 2 - Priestley-Taylor equation
\li processCase(5) = 3 - Penam-Monteith equation

<CENTER>

<b> Name | Unit | Temporal resolution </b> |
| :------------------------- | :------------------------- | :------------------------- |
| -------------------------- | -------------------------- | -------------------------- |
0 - Potential evapotranspiration | \f$\mathrm{mm}\f$ | hourly to daily
1 - Minimum air temperature | \f$^\circ \mathrm{C}\f$ | daily
1 - Maximum air temperature | \f$^\circ \mathrm{C}\f$ | daily
2 - Net radiation | \f$ W\;m^{-2} \f$ | daily
3 - Net radiation | \f$ W\;m^{-2} \f$ | daily
3 - Absolut vapur pressure of air | \f$ Pa \f$ | daily
3 - Windspeed | \f$ m\;s^{-1} \f$ | daily
</CENTER>


\subsection morph_data Morphological variables

Expand All @@ -60,51 +60,51 @@ SRTM data and a number of derived products in different resolutions are availabl
Soil and hydrogeological data is usually provided by the geological surveys. On the soil side the
Harmonized World Soil Database would be a free alternative (http://webarchive.iiasa.ac.at/Research/LUC/External-World-soil-database/HTML/).

<CENTER>

<b> Name | Unit | Temporal resolution </b>
| :------------------------- | :------------------------- | :------------------------- |
| -------------------------- | -------------------------- | -------------------------- |
Digital elevation model | \f$\mathrm{m}\f$ | -
Soil maps with textural properties<br />(\% sand and clay contents, bulk density per horizon, and root depth zone) | - | -
Soil maps with textural properties<br />(\% sand and clay contents, bulk density per horizon,<br />and root depth zone) | - | -
Geological maps with aquifer properties<br />(specific yield, permeability, aquifer thickness) | - | -
Streamflow location | \f$(\mathrm{m}, \mathrm{m})\f$ (lat,lon) | -
</CENTER>


\subsection luse_data Land Cover

Free land cover data is available from different sources. The Corine programm provides land cover scenes for Europe
with resolutions of 100m and 250m (http://www.eea.europa.eu/publications/COR0-landcover), the Global Land Cover Map 2000
a dateset covers the entire world in a resolution of 1km.

<CENTER>

<b> Name | Unit | Temporal resolution </b>
| :------------------------- | :------------------------- | :------------------------- |
| -------------------------- | -------------------------- | -------------------------- |
Land cover scenes | - | monthly to annual
Leaf area index | - | weekly to monthly
</CENTER>


\subsection gauge_data Gauging Station Information

Streamflow measurments should also be available from federal authorities. In addition, the Global Runoff Data Center provides
timeseries of varying length for several thousand gauging stations all over the world (http://www.bafg.de/GRDC)

<CENTER>

| <b>Name</b> | <b>Unit</b> | <b>Temporal resolution </b> |
| :------------------------- | :------------------------- | :------------------------- |
| -------------------------- | -------------------------- | -------------------------- |
| Streamflow measurements | \f$\mathrm{m}^3 \mathrm{s}^{-1}\f$ | hourly to daily
</CENTER>


\subsection optional Optional Data

<CENTER>

|<b> Name | Unit | Temporal resolution </b>
| :------------------------- | :------------------------- | :------------------------- |
| -------------------------- | -------------------------- | -------------------------- |
Snow cover | - | daily to weekly
Land surface temperature | \f$\mathrm{K}\f$ | daily to weekly
Groundwater station location | \f$(\mathrm{m}, \mathrm{m})\f$ (lat,lon) | -
Groundwater head measurements | \f$\mathrm{m}\f$ | weekly to monthly
Eddy covariance station location | \f$(\mathrm{m}, \mathrm{m})\f$ (lat,lon) | -
Eddy covariance measurements | \f$\mathrm{m}\f$ | hourly
</CENTER>



\section meteo Preparation of the Forcings
Expand Down Expand Up @@ -239,9 +239,9 @@ MHM needs several morphological input datasets. All these have to be provided as

The required datasets and their corresponding filenames:

<CENTER>

<b> Description | Raster file name | Table file name </b> |
| :------------------------- | :------------------------- | :------------------------- |
| -------------------------- | -------------------------- | -------------------------- |
Sink filled Digital Elevevation Model (DEM) | dem.asc | -
Slope map | slope.asc | -
Aspect Map | aspect.asc | -
Expand All @@ -252,7 +252,7 @@ Soil map | soil_class.asc | soil_classdefinition.txt
Hydrogeological map | geology_class.asc | geology_classdefinition.txt
Leaf Area Index (LAI) map | LAI_class.asc | LAI_classdefinition.txt
Land use map | your choice | -
</CENTER>


\section gis A possible GIS workflow

Expand Down Expand Up @@ -398,13 +398,13 @@ In case the necessary stream network file is not available, you can get one from
Unlike the other classified datasets (soils, hydrogeology, LAI), where as much information as available can be added, the land use data is restricted to
three different classes, which are listed below:

<CENTER>

Class | Description |
| :------------------------- | :------------------------- |
| -------------------------- | -------------------------- |
1 | Forest
2 | Impervious
3 | Pervious
</CENTER>


\section tables Table Data

Expand All @@ -421,44 +421,44 @@ files are presented. All fields are further listed and described in the repectiv
\image html soil_classdefinition.png "A possible 'soil_classdefinion.txt' file"
\anchor fig_soil_classdefinition \image latex soil_classdefinition.pdf "A possible 'soil_classdefinion.txt' file" width=16cm

<CENTER>

| Field | Description
| :------------------------- | :------------------------- |
| -------------------------- | -------------------------- |
MU_GLOBAL | Soil id as given in the corresponding 'soil_class.asc' map. All raster map ids must be given here
HORIZON | Horizon number starting at the top of the soil column.<br />Your are free to provide any number of horizons for each soil individually
UD[mm] | Upper depth of the horizon in millimeter.<br />Should be 0 for the first, and the lower depth of the superimposing horizon for all others
LD[mm] | Lower depth of the horizon in millimeter
CLAY[%] | Clay content in percent
SAND[%] | Sand content in percent
BD[gcm-3] | Mineral bulk density in grams per cubic centimeter
</CENTER>


\subsection hydrogeo_table The hydrogeolgy look-up table

\image html geology_classdefinition.png "A possible 'geology_classdefinion.txt' file"
\anchor fig_geology_classdefinition \image latex geology_classdefinition.pdf "A possible 'geology_classdefinion.txt' file" width=16cm

<CENTER>

Field | Description
| :------------------------- | :------------------------- |
| -------------------------- | -------------------------- |
GeoParam(i) | Parameter number of the formation, the link to 'mhm_parameter.nml'
ClassUnit | Class id as present in the 'hydrogeology_class.asc' raster map
Karstic | Presence of karstic formation (0: False, 1: True)
Description | Text description of the unit
</CENTER>


\subsection lai_table The LAI look-up table

\image html lai_classdefinition.png "A possible 'LAI_classdefinion.txt' file"
\anchor fig_lai_classdefinition \image latex lai_classdefinition.pdf "A possible 'LAI_classdefinion.txt' file" width=16cm

<CENTER>

Field | Description
| :------------------------- | :------------------------- |
| -------------------------- | -------------------------- |
ID | LAI class id as given in the file LAI_class.asc
LAND-USE | Description of the LAI class
Jan. to Dec. | Monthly LAI values
</CENTER>


\subsection gauge_files The gauge files

Expand All @@ -469,16 +469,16 @@ Jan. to Dec. | Monthly LAI values
The structure of the gauge files is different from the look-up tables listed
so far. The following table describes its content.

<CENTER>

Line | Description
| :------------------------- | :------------------------- |
| -------------------------- | -------------------------- |
1 | Gives basic information about the gauging station (Station-Id:Station-Name/River-Name)
2 | Specifies the nodata value
3 | The number of measurements per day
4 | The start date of the time series in the format given in parentheses
5 | The end date of the time series in the format given in parentheses
6 to end | The measurement data in cubic meter per second <br />preceded by the actual date in the same format as the dates of lines four and five
</CENTER>


For every gauge id given in 'idgauges.asc' one gauge file has to be created as outlined above. The file name has to <b> exactly </b> reflect the gauge id and carry a '.txt' extension.
The table data file for a gauge with an id of 0343 in 'idgauges.asc' should
Expand Down
9 changes: 7 additions & 2 deletions doc/html_files/html_extra.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,11 @@ div.image div.caption{
/* color:#5555FF; */
}

table{
padding:1px;
.contents table:not(.memberdecls):not(.mlabels):not(.fieldtable):not(.memname) {
display: block;
}

.contents table:not(.memberdecls):not(.mlabels):not(.fieldtable):not(.memname) tbody {
display: table;
width: 100%;
}

0 comments on commit 028a2bf

Please sign in to comment.