roms-tools 2.2.0__py3-none-any.whl → 2.3.0__py3-none-any.whl

{roms_tools-2.2.0.dist-info → roms_tools-2.3.0.dist-info}/RECORD

@@ -1,38 +1,40 @@
 ci/environment.yml,sha256=bwK5Lz4j44gY2ee2Edn3ftXnfvYbRUVvFXVJH7T-oro,198
-roms_tools/__init__.py,sha256=UdCkky5JiiUlqPlG0MwQdhm6uxsY0bkDuaxi4xOB3Ls,846
-roms_tools/utils.py,sha256=kMlVbaDcokPBqXN0307Dwt10Z8-qMcvbRLiDMX8fUpk,12230
+roms_tools/__init__.py,sha256=lncxTF_gktPQIbxQk_hzEykCvrVOrLWxByRSluUOGbs,915
+roms_tools/download.py,sha256=W6S_DFVJDXat2w9MfyyHyushrswbpUI2hxegSuua1XE,6248
+roms_tools/plot.py,sha256=n0jI2uOzuO1Rv5x1AfP16qinsM19-_k91p2b3qM5FxY,13213
+roms_tools/regrid.py,sha256=OBlW-KnQfXmxSZ5MwNoroxU51sI8-3ZRQhEPX3maj1A,5173
+roms_tools/utils.py,sha256=Tu4opo8I85uI3XpuPoeZmjfnBEoQMkGlIehB8SiStJY,23436
+roms_tools/vertical_coordinate.py,sha256=J36HpZ1ADQM3asUjmBu_tpr6sVFSoF2JQdOnWBtXHo4,9826
+roms_tools/analysis/roms_output.py,sha256=7X_w9_8bg4x9XUL50ktzQIHmByVcCBFa5gFOsnpot50,23110
 roms_tools/setup/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-roms_tools/setup/boundary_forcing.py,sha256=VocsvG3g9hQxzYO9gdy2bxZAaJc9oQlT7hpurcAi71Y,43067
-roms_tools/setup/datasets.py,sha256=-SI5EAwgGzZ8ChM1YKU9lNi-M4tRRqG5RefEyHZcQyQ,86167
-roms_tools/setup/download.py,sha256=TgDC3TdE_njFGbPYJprAN8J1nYeOWFzavQhUfOGwAYk,5927
+roms_tools/setup/boundary_forcing.py,sha256=aRo9bdWaRI6AMTc2iA1Fj0nOjzhskhtzvHW-pCLFF9Q,43375
+roms_tools/setup/datasets.py,sha256=QpwD5CaRB4gSnvFWLep7oWJTnUZg-7vKiF_Z-79-vn4,81343
 roms_tools/setup/fill.py,sha256=YQes_9uADZ-XZ6dBqXyvG7OAp7UrWhX-p3pR1gD6Od4,11120
-roms_tools/setup/grid.py,sha256=hpECjTC8Bz3ysvabar7t7ZtsTanqxjvHtYHgnyFcVYQ,51293
-roms_tools/setup/initial_conditions.py,sha256=NuTOqig8navFJ6IysXwK5pKd2selkRWrFaiedtRqqiw,37059
+roms_tools/setup/grid.py,sha256=OIQl1bGbg5G87oScDPsfMOuGlMKk9J_ppS3DmPhKZCU,52994
+roms_tools/setup/initial_conditions.py,sha256=XdM5Nc3mBgKf_TplGumt60lIfJMb2_O5KZbbQtb5GK4,34396
 roms_tools/setup/mask.py,sha256=IK2SrVnMJwZjE4jNFtzMQhp1c5c8SUO45OIpCIrNSis,3413
-roms_tools/setup/nesting.py,sha256=CB9bGizmNaQ74niARyRf-p0lY7c3CPhXTfdenmbIPOQ,21013
-roms_tools/setup/plot.py,sha256=Qs-JgHXQGfHcMg2cfn4TMYeDuJh2dMUgMMrndHr_jH4,12866
-roms_tools/setup/regrid.py,sha256=OBlW-KnQfXmxSZ5MwNoroxU51sI8-3ZRQhEPX3maj1A,5173
-roms_tools/setup/river_forcing.py,sha256=Ox61M_SNousC_FLwmBoR865oiTyisbvJb4bcEaJZfg4,27364
-roms_tools/setup/surface_forcing.py,sha256=-i2lAxv_vhjO2QQyWPfLg1mIIOx4N0VDmMUrkI1V0qQ,21409
-roms_tools/setup/tides.py,sha256=EgsPsLY70ERB6q2w1DClRQZvSbX-i_Ypume01Ub_EYU,28257
-roms_tools/setup/topography.py,sha256=pKf2EmUc85meKN5aDkN1fY2U3Zn5nn80RDqzaEfpvvw,13475
-roms_tools/setup/utils.py,sha256=1WzeRF8hf-00cnh2M73nsyvMQxDfHqXF2AMI947iyDk,46494
-roms_tools/setup/vertical_coordinate.py,sha256=yw3L_ONELAZfOHwNvcyQaJ0Vqir05FRzFBd601eTLUM,2689
+roms_tools/setup/nesting.py,sha256=UsJNltTdfQC6kWCNDKYMv9ylpQTepfAeH2RskROPg3A,20996
+roms_tools/setup/river_forcing.py,sha256=4OXkpvgWzgGaj-sY9_iScQs9HkmpJwot2-6jXRpm5Fs,27321
+roms_tools/setup/surface_forcing.py,sha256=dw0EuIf6UdXiRIWzJVrqEOwDaX3f5TIIqgF5_gTXKPg,21425
+roms_tools/setup/tides.py,sha256=M_CaXWozVculR_wYBtSuiQyzKIaru15IPnoY3WkLxOM,28344
+roms_tools/setup/topography.py,sha256=8cZczFV4w71jGJ6puuNh2TyaN4_TWjtGV1FT-a1NaBQ,13469
+roms_tools/setup/utils.py,sha256=0qaAhUanOHZzoaacV8ynAn0rA1JV8Gm8eINRrOs7THM,41709
 roms_tools/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+roms_tools/tests/test_regrid.py,sha256=-hFsULcJOJs90UdHrEcZa455vMZfcmXeFEFt8mnCVyo,1885
 roms_tools/tests/test_utils.py,sha256=X16UHYzd8KmUgxBHJqmVP6cIHfOtScCdXPw905bgGMk,7966
+roms_tools/tests/test_analysis/test_roms_output.py,sha256=cnGiD9yA7LqBMKaJkm_P_XQ490dUn_ZjGdyttFTbhBk,9831
 roms_tools/tests/test_setup/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-roms_tools/tests/test_setup/test_boundary_forcing.py,sha256=izCr5zRLtCsbWa2jjEvuAP5Q941A_erDn1S3Ao5eXU0,14425
-roms_tools/tests/test_setup/test_datasets.py,sha256=Pxh95V-x-EaemVm6F_T0TbtrEp4Lh1_OAaOxPwTLrfQ,16441
+roms_tools/tests/test_setup/test_boundary_forcing.py,sha256=sW7aZjUKP2eEwZwlzkCmnSR-VyZPDMEihsP0xwLMc4s,14419
+roms_tools/tests/test_setup/test_datasets.py,sha256=EInjmCLFNWJoO8nIQJhDtmFmMFmjcrr5L_5vJYm-qno,16435
 roms_tools/tests/test_setup/test_fill.py,sha256=gDHuM58d3ECQE317ZntChYt4hWCfo4eVhkW13NiZ1V4,3735
-roms_tools/tests/test_setup/test_grid.py,sha256=oGRiM2mqKuQavlS0C52ambLURu64Yc7zwaKYQxt5tOk,14663
-roms_tools/tests/test_setup/test_initial_conditions.py,sha256=IFEUgice0hWPKQkQg44d5CJNJ-Cli1vYCK8a0kVAcvM,11201
+roms_tools/tests/test_setup/test_grid.py,sha256=9Jw2r_xYafEbI5BauZJgXQD2133mil4yHxj4nwTU9dY,14657
+roms_tools/tests/test_setup/test_initial_conditions.py,sha256=hloWo01wiQEKh3rzhNi2sE0BL1sw40BvTZjoXTIVRjA,11303
 roms_tools/tests/test_setup/test_nesting.py,sha256=_LB_10XgGkQ6DmpHp5rgIWTEN6nR14aZY8B_ADX4cRQ,18525
-roms_tools/tests/test_setup/test_regrid.py,sha256=NMzMkPHaFfO_9H0SbIpFL3VHlzhd71gUVLu81QmU-bs,1891
-roms_tools/tests/test_setup/test_river_forcing.py,sha256=K0XoT8sIbqoFGyIkK6oPOPpihAJftXrcsymV2q5tD6o,12010
-roms_tools/tests/test_setup/test_surface_forcing.py,sha256=oa_Nma8syqVw5_V3UHySIRCrJHdbunsmLXj4Fk7foaA,25000
-roms_tools/tests/test_setup/test_tides.py,sha256=o5oY718nQg3cXuK7Ark0uOtkFF8KuJZI3wQcJwyz8O8,8577
-roms_tools/tests/test_setup/test_topography.py,sha256=RlkQ_zaJzXi75Y5kRCtHA9JO93MRPlj7LNjXIICI9Mk,4969
-roms_tools/tests/test_setup/test_utils.py,sha256=lVeeiEEk_nR0zdmAdRHMlkBUNrAZMiZFrHaLQNy_lPE,585
+roms_tools/tests/test_setup/test_river_forcing.py,sha256=9VX7FgN6VFHcZSZwWfKM6fUwIIEiAUorllXWDyZeUI8,12004
+roms_tools/tests/test_setup/test_surface_forcing.py,sha256=jWz0XlCo2Gkk_Xk2zGxFSPfIO34rqtbnMHrw3WMeZis,24994
+roms_tools/tests/test_setup/test_tides.py,sha256=d02gKVhWkgpNu8O5w6VDL4BXtbNVYNZttf8tPbwcWnc,8571
+roms_tools/tests/test_setup/test_topography.py,sha256=EAF-zCHfo6XnXQfBTrSZLuZDVzegWHHlrf9oBmvY0hM,4963
+roms_tools/tests/test_setup/test_utils.py,sha256=7zTmEsCqZ4pQBbECxhC420dT4fMo06ExKyxUL5TMaZ0,2204
 roms_tools/tests/test_setup/test_validation.py,sha256=suAkZkcxum5I7uUI2eIXxutLk6yQPtXOCSKrfSIMbN4,2294
 roms_tools/tests/test_setup/test_data/bgc_boundary_forcing_from_climatology.zarr/.zattrs,sha256=tS9VXhST813qsPHqGFwK0IMH6t1iUfxhcNTpsS1p0ns,360
 roms_tools/tests/test_setup/test_data/bgc_boundary_forcing_from_climatology.zarr/.zgroup,sha256=I4N0bme0vMJ2Kz8QDwbD-i1fFJq1qOXaXTNSFGSgGVk,24
@@ -1048,8 +1050,8 @@ roms_tools/tests/test_setup/test_data/tidal_forcing.zarr/v_Im/0.0.0,sha256=60jWZ
 roms_tools/tests/test_setup/test_data/tidal_forcing.zarr/v_Re/.zarray,sha256=2P8kKjSgdw5-3udU-vGJ3bzhNuRn7fZmWN811qBJn34,357
 roms_tools/tests/test_setup/test_data/tidal_forcing.zarr/v_Re/.zattrs,sha256=2z7WUPvCT9VfFs8VCBltFHLWgaGj1jcw3yZ4n0viLRg,197
 roms_tools/tests/test_setup/test_data/tidal_forcing.zarr/v_Re/0.0.0,sha256=33Gl8otBmgqVarmAnZuEqTYS2_hVJUJh-iN1HzvaDuo,96
-roms_tools-2.2.0.dist-info/LICENSE,sha256=yiff76E4xRioW2bHhlPpyYpstmePQBx2bF8HhgQhSsg,11318
-roms_tools-2.2.0.dist-info/METADATA,sha256=ez12LSQgsVdNz-ujYb7B26bIgVYhDi35_ZJRjPYEpEI,4244
-roms_tools-2.2.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-roms_tools-2.2.0.dist-info/top_level.txt,sha256=aAf4T4nYQSkay5iKJ9kmTjlDgd4ETdp9OSlB4sJdt8Y,19
-roms_tools-2.2.0.dist-info/RECORD,,
+roms_tools-2.3.0.dist-info/LICENSE,sha256=yiff76E4xRioW2bHhlPpyYpstmePQBx2bF8HhgQhSsg,11318
+roms_tools-2.3.0.dist-info/METADATA,sha256=uBNABK8KhsXCBlJYOBuYL9n4xWtQXboIFSftozCT7y0,4244
+roms_tools-2.3.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+roms_tools-2.3.0.dist-info/top_level.txt,sha256=aAf4T4nYQSkay5iKJ9kmTjlDgd4ETdp9OSlB4sJdt8Y,19
+roms_tools-2.3.0.dist-info/RECORD,,

roms_tools/setup/vertical_coordinate.py

@@ -1,109 +0,0 @@
-import numpy as np
-import xarray as xr
-from roms_tools.setup.utils import transpose_dimensions
-
-
-def compute_cs(sigma, theta_s, theta_b):
-    """Compute the S-coordinate stretching curves according to Shchepetkin and
-    McWilliams (2009).
-
-    Parameters
-    ----------
-    sigma : np.ndarray or float
-        The sigma-coordinate values.
-    theta_s : float
-        The surface control parameter.
-    theta_b : float
-        The bottom control parameter.
-
-    Returns
-    -------
-    C : np.ndarray or float
-        The stretching curve values.
-
-    Raises
-    ------
-    ValueError
-        If theta_s or theta_b are not within the valid range.
-    """
-    if not (0 < theta_s <= 10):
-        raise ValueError("theta_s must be between 0 and 10.")
-    if not (0 < theta_b <= 4):
-        raise ValueError("theta_b must be between 0 and 4.")
-
-    C = (1 - np.cosh(theta_s * sigma)) / (np.cosh(theta_s) - 1)
-    C = (np.exp(theta_b * C) - 1) / (1 - np.exp(-theta_b))
-
-    return C
-
-
-def sigma_stretch(theta_s, theta_b, N, type):
-    """Compute sigma and stretching curves based on the type and parameters.
-
-    Parameters
-    ----------
-    theta_s : float
-        The surface control parameter.
-    theta_b : float
-        The bottom control parameter.
-    N : int
-        The number of vertical levels.
-    type : str
-        The type of sigma ('w' for vertical velocity points, 'r' for rho-points).
-
-    Returns
-    -------
-    cs : xr.DataArray
-        The stretching curve values.
-    sigma : xr.DataArray
-        The sigma-coordinate values.
-
-    Raises
-    ------
-    ValueError
-        If the type is not 'w' or 'r'.
-    """
-    if type == "w":
-        k = xr.DataArray(np.arange(N + 1), dims="s_w")
-        sigma = (k - N) / N
-    elif type == "r":
-        k = xr.DataArray(np.arange(1, N + 1), dims="s_rho")
-        sigma = (k - N - 0.5) / N
-    else:
-        raise ValueError(
-            "Type must be either 'w' for vertical velocity points or 'r' for rho-points."
-        )
-
-    cs = compute_cs(sigma, theta_s, theta_b)
-
-    return cs, sigma
-
-
-def compute_depth(zeta, h, hc, cs, sigma):
-    """Compute the depth at different sigma levels.
-
-    Parameters
-    ----------
-    zeta : xr.DataArray or scalar
-        The sea surface height.
-    h : xr.DataArray
-        The depth of the sea bottom.
-    hc : float
-        The critical depth.
-    cs : xr.DataArray
-        The stretching curve values.
-    sigma : xr.DataArray
-        The sigma-coordinate values.
-
-    Returns
-    -------
-    z : xr.DataArray
-        The depth at different sigma levels.
-    """
-
-    z = (hc * sigma + h * cs) / (hc + h)
-    z = zeta + (zeta + h) * z
-
-    z = -transpose_dimensions(z)
-
-    return z