Skip to content

Commit

Permalink
Update _make_hgrid docstring (#82)
Browse files Browse the repository at this point in the history
* Update docstring as pointed out in issue 52

* black reformat

* navid comment
  • Loading branch information
ashjbarnes authored Nov 15, 2023
1 parent 879b07d commit 9388117
Showing 1 changed file with 3 additions and 7 deletions.
10 changes: 3 additions & 7 deletions regional_mom6/regional_mom6.py
Original file line number Diff line number Diff line change
Expand Up @@ -510,14 +510,10 @@ def __init__(
def _make_hgrid(self, gridtype):
"""Sets up hgrid based on users specification of
domain. Default behaviour leaves latitude and longitude evenly
spaced.
If user specifies a resolution of 0.1 degrees, longitude is
spaced this way and latitude spaced with 0.1
cos(mean_latitude). This way, grids in the centre of the
domain are perfectly square, but decrease monatonically in
area away from the equator
spaced. This is very simple but suitable for small domains.
Note:
The intention is for the hgrid generation to be very flexible. For now there is only one implemented horizontal grid included in the package, but you can customise it by simply overwriting the `hgrid.nc` file that's deposited in your `rundir` after initialising an `experiment`. To conserve the metadata, it might be easiest to read the file in, then modify the fields before re-saving.
"""

if gridtype == "even_spacing":
Expand Down

0 comments on commit 9388117

Please sign in to comment.