diff --git a/docs/api.rst b/docs/api.rst index da9859b..ce9bac0 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -2,9 +2,22 @@ API Reference ############# +UFS Datasets +------------ + .. autosummary:: :toctree: generated/ ufs2arco.FV3Dataset ufs2arco.MOM6Dataset ufs2arco.CICE6Dataset + + +Regridding +---------- + +.. autosummary:: + :toctree: generated/ + + ufs2arco.MOM6Regridder + ufs2arco.CICE6Regridder diff --git a/docs/conf.py b/docs/conf.py index 24df7f2..47dbb12 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -35,6 +35,8 @@ napoleon_custom_sections = [("Returns", "params_style"), ("Sets Attributes", "params_style"), ("Assumptions", "notes_style"), + ("Required Fields in Config", "params_style"), + ("Optional Fields in Config", "params_style"), ] diff --git a/docs/config-replay.yaml b/docs/config-replay.yaml index 6e3cf79..6ff02da 100644 --- a/docs/config-replay.yaml +++ b/docs/config-replay.yaml @@ -72,10 +72,8 @@ MOM6Dataset: time : 1 z_l : -1 z_i : -1 - yh : 60 - xh : 60 - yq : 60 - xq : 60 + lat : 60 + lon : 60 coords: - xh @@ -150,3 +148,10 @@ CICE6Dataset: - hi - Tsfc - aice + +MOM6Regridder: + rotation_file: + weights_file_t2t: + weights_file_u2t: + weights_file_v2t: + periodic: True diff --git a/docs/example_replay_mom6.ipynb b/docs/example_replay_mom6.ipynb index 28bfab5..6cf54a6 100644 --- a/docs/example_replay_mom6.ipynb +++ b/docs/example_replay_mom6.ipynb @@ -30,7 +30,7 @@ "source": [ "import sys\n", "sys.path.append(\"..\")\n", - "from ufs2arco import MOM6Dataset" + "from ufs2arco import MOM6Dataset, MOM6Regridder" ] }, { @@ -195,8 +195,8 @@ "name": "stdout", "output_type": "stream", "text": [ - "CPU times: user 4.61 s, sys: 2.3 s, total: 6.9 s\n", - "Wall time: 20.6 s\n" + "CPU times: user 2.81 s, sys: 933 ms, total: 3.75 s\n", + "Wall time: 6.37 s\n" ] }, { @@ -608,8 +608,8 @@ " NumFilesInSet: 1\n", " title: UFS\n", " grid_type: regular\n", - " grid_tile: N/A