Skip to content
Snippets Groups Projects
Commit f6d93a00 authored by Felix Kleinert's avatar Felix Kleinert
Browse files

updte some docstr

parent 1973d71e
No related branches found
No related tags found
1 merge request!231Draft: Resolve "Create WRF-Chem data handler"
...@@ -7,25 +7,27 @@ import numpy as np ...@@ -7,25 +7,27 @@ import numpy as np
import xarray as xr import xarray as xr
from mlair.helpers.helpers import convert2xrda from mlair.helpers.helpers import convert2xrda
from typing import Union from typing import Union, Tuple
xr_int_float = Union[xr.DataArray, xr.Dataset, np.ndarray, int, float] xr_int_float = Union[xr.DataArray, xr.Dataset, np.ndarray, int, float]
tuple_of_2xr_int_float = Tuple[xr_int_float, xr_int_float]
def deg2rad_all_points(lat1, lon1, lat2, lon2): def deg2rad_all_points(lat1: xr_int_float, lon1: xr_int_float,
lat2: xr_int_float, lon2: xr_int_float) -> Tuple[tuple_of_2xr_int_float, tuple_of_2xr_int_float]:
""" """
Converts coordinates provided in lat1, lon1, lat2, and lon2 from deg to rad. In fact this method just calls Converts coordinates provided in lat1, lon1, lat2, and lon2 from deg to rad. In fact this method just calls
dasks deg2rad method on all inputs and returns a tuple of tuples. dasks deg2rad method on all inputs and returns a tuple of tuples.
:param lat1: :param lat1: Latitude(-s) of first location
:type lat1: :type lat1:
:param lat2: :param lon1: Longitude(-s) of first location
:type lat2:
:param lon1:
:type lon1: :type lon1:
:param lon2: :param lat2: Latitude(-s) of second location
:type lat2:
:param lon2: Longitude(-s) of second location
:type lon2: :type lon2:
:return: :return: Lats and lons in radians ((lat1, lon1), (lat2, lon2))
:rtype: :rtype:
""" """
lat1, lon1, lat2, lon2 = da.deg2rad(lat1), da.deg2rad(lon1), da.deg2rad(lat2), da.deg2rad(lon2) lat1, lon1, lat2, lon2 = da.deg2rad(lat1), da.deg2rad(lon1), da.deg2rad(lat2), da.deg2rad(lon2)
...@@ -40,6 +42,7 @@ def haversine_dist(lat1: xr_int_float, lon1: xr_int_float, ...@@ -40,6 +42,7 @@ def haversine_dist(lat1: xr_int_float, lon1: xr_int_float,
on the Earth (specified in decimal degrees or in radians) on the Earth (specified in decimal degrees or in radians)
Reference: ToBeAdded Reference: ToBeAdded
(First implementation provided by M. Langguth)
:param lat1: Latitude(-s) of first location :param lat1: Latitude(-s) of first location
:param lon1: Longitude(-s) of first location :param lon1: Longitude(-s) of first location
......
...@@ -7,6 +7,7 @@ import math ...@@ -7,6 +7,7 @@ import math
import numpy as np import numpy as np
import xarray as xr import xarray as xr
import dask.array as da
from typing import Dict, Callable, Union, List, Any from typing import Dict, Callable, Union, List, Any
...@@ -158,6 +159,9 @@ def convert2xrda(arr: Union[xr.DataArray, xr.Dataset, np.ndarray, int, float], ...@@ -158,6 +159,9 @@ def convert2xrda(arr: Union[xr.DataArray, xr.Dataset, np.ndarray, int, float],
return arr return arr
else: else:
if use_1d_default: if use_1d_default:
if isinstance(arr, da.core.Array):
raise TypeError(f"`use_1d_default=True' is used with `arr' of type da.array. For da.arrays please "
f"pass `use_1d_default=False' and specify keywords for xr.DataArray via kwargs.")
dims = kwargs.pop('dims', 'points') dims = kwargs.pop('dims', 'points')
coords = kwargs.pop('coords', None) coords = kwargs.pop('coords', None)
try: try:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment