You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/configuration.rst
+52-41
Original file line number
Diff line number
Diff line change
@@ -91,8 +91,6 @@ This section contains options for CHM and the simulation in general. This is a r
91
91
{
92
92
"option":
93
93
{
94
-
"station_N_nearest": 1,
95
-
"interpolant": "nearest",
96
94
"per_triangle_timeseries": false,
97
95
"ui": false,
98
96
"debug_level": "debug",
@@ -102,40 +100,6 @@ This section contains options for CHM and the simulation in general. This is a r
102
100
}
103
101
}
104
102
105
-
.. confval:: station_search_radius
106
-
107
-
:type: double
108
-
:default: None
109
-
110
-
111
-
The search radius (meters) surrounding any given triangle within which to search for a station. This is used to ensure only "close" stations are used. Cannot be used when ``station_N_nearest`` is set. Based off the center of the triangle.
112
-
113
-
114
-
.. confval:: station_N_nearest
115
-
116
-
:type: int
117
-
:default: 5
118
-
119
-
Use the nearest N stations to include for the interpolation at a triangle. Based off the center of the triangle.
120
-
121
-
Both ``station_search_radius`` and ``station_N_nearest`` cannot be
122
-
simultaneously specified. If neither is specific, then ``station_N_nearest:5`` is used as default. If the :confval:`interpolant` mode is ``nearest``, then this is automatically set to 1.
123
-
124
-
125
-
.. confval:: interpolant
126
-
127
-
:type: string
128
-
:default: "spline"
129
-
130
-
Chooses either thin plate spline with tension (spline) or inverse
131
-
distance weighting (idw). Nearest selects the closest
132
-
station and only uses that with no interpolation.
133
-
134
-
.. code:: json
135
-
136
-
"interpolant" : "idw"
137
-
"interpolant" : "spline"
138
-
"interpolant" : "nearest"
139
103
140
104
.. confval:: point_mode
141
105
@@ -591,13 +555,11 @@ All of the frequency options can mixed together, allowing more complex output fr
591
555
592
556
593
557
594
-
595
-
596
-
597
558
forcing
598
559
*********
599
560
600
-
Input forcing can be either a ASCII timeseries or a NetCDF. Please see :ref:`forcing` for more details.
561
+
Input forcing can be either a ASCII timeseries or a NetCDF. Please see :ref:`forcing`
562
+
for more details on the file specifications.
601
563
602
564
.. warning::
603
565
@@ -606,7 +568,12 @@ Input forcing can be either a ASCII timeseries or a NetCDF. Please see :ref:`for
606
568
607
569
Input forcing stations do not need to be located within the simulation
608
570
domain. Therefore they can act as ‘virtual stations’ so-as to use
609
-
reanalysis data, or met stations located outside of the basin.
571
+
reanalysis data, or met stations located outside of the basin. However, because global datasets
572
+
cannot generally be loaded all at once into memory without significant memory pressure, the met loader
573
+
only loads points that are within the bounding box of the mesh. For MPI runs, it only loads within
574
+
the ranks' meshe sub-domain bounding box. If the number of stations within the bounding box cannot
575
+
fullfill `num_stations_to_use`, the bounding box is expanded by 25% (up to 3 times).
576
+
610
577
611
578
An example of this is shown below, where each black point is a virtual station, representing the center for a NetCDF grid cell from a NWP product.
612
579
@@ -628,7 +595,46 @@ An example of this is shown below, where each black point is a virtual station,
628
595
629
596
Specify if a NetCDF (.nc) file will be used. Cannot be used along with ASCII inputs!
630
597
598
+
.. confval:: station_search_radius
599
+
600
+
:type: double
601
+
:default: None
602
+
603
+
604
+
The search radius (meters) surrounding any given triangle within which to search for a station. This is used to ensure only "close" stations are used. Cannot be used when ``station_N_nearest`` is set. Based off the center of the triangle.
605
+
606
+
.. confval:: num_stations_to_use
607
+
608
+
This is removed in favour of ``num_stations_to_use``.
609
+
610
+
611
+
612
+
.. confval:: num_stations_to_use
613
+
614
+
:type: int
615
+
:default: 5
616
+
617
+
The number of forcing inputs, e.g., netcdf cell centres or station timeseries, to include for the interpolation at a triangle.
631
618
619
+
Both ``station_search_radius`` and ``num_forcing_inputs`` cannot be
620
+
simultaneously specified. If neither is specific, then ``num_forcing_inputs:5`` is used as default.
621
+
If the :confval:`interpolant` mode is ``nearest``, then this is automatically set to 1.
622
+
623
+
624
+
.. confval:: interpolant
625
+
626
+
:type: string
627
+
:default: "spline"
628
+
629
+
Chooses either thin plate spline with tension (spline) or inverse
630
+
distance weighting (idw). Nearest selects the closest
631
+
station and only uses that with no interpolation.
632
+
633
+
.. code:: json
634
+
635
+
"interpolant" : "idw"
636
+
"interpolant" : "spline"
637
+
"interpolant" : "nearest"
632
638
633
639
.. note::
634
640
@@ -673,6 +679,9 @@ does *not* require an addition ``"forcing":`` section definition.
673
679
674
680
"forcing":
675
681
{
682
+
683
+
"num_forcing_inputs": 1,
684
+
"interpolant": "nearest",
676
685
"some_station":
677
686
{
678
687
//definition
@@ -802,6 +811,8 @@ If a multipart file is to be used, simply replace the netcdf with the json list.
802
811
803
812
"use_netcdf": true,
804
813
"file":"metadata.json",
814
+
"num_forcing_inputs": 1,
815
+
"interpolant": "nearest",
805
816
}
806
817
807
818
Please see the NetCDF :ref:`forcing` section for more details.
0 commit comments