From 6175f1c76f7feaba21287e8d32aa5b75de92e3f7 Mon Sep 17 00:00:00 2001 From: "Navid C. Constantinou" Date: Fri, 24 Jan 2025 10:57:18 +1100 Subject: [PATCH] updates --- docs/{angle_calc.md => angle_calculation.md} | 5 +++-- docs/api.rst | 4 ++-- docs/index.rst | 2 +- 3 files changed, 6 insertions(+), 5 deletions(-) rename docs/{angle_calc.md => angle_calculation.md} (95%) diff --git a/docs/angle_calc.md b/docs/angle_calculation.md similarity index 95% rename from docs/angle_calc.md rename to docs/angle_calculation.md index 44d214e5..fd91c797 100644 --- a/docs/angle_calc.md +++ b/docs/angle_calculation.md @@ -1,5 +1,6 @@ -# Rotation and angle calculation in regional-mom6 using MOM6 Angle Calculation -This document explains the implementation of MOM6 angle calculation in regional-mom6, which is the process by which regional-mom6 calculates the angle of curved hgrids. +# Rotation and angle calculation in regional-mom6 using MOM6 Angle Calculation + +Here we explain the implementation of MOM6 angle calculation in regional-mom6, which is the process by which regional-mom6 calculates the angle of curved horizontal grids (``hgrids``). **Issue:** MOM6 doesn't actually use the user-provided "angle_dx" field in input hgrids, but internally calculates the angle. diff --git a/docs/api.rst b/docs/api.rst index 93087763..51d45032 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,5 +1,5 @@ -regional\_mom6 package -====================== +API reference +============= Submodules ---------- diff --git a/docs/index.rst b/docs/index.rst index 2cd3006a..da6fe799 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -92,7 +92,7 @@ The bibtex entry for the paper is: demos mom6-file-structure-primer regional-mom6-workflow - angle_calc + angle_calculation api contributing docker_image_dev