Skip to content

Commit

Permalink
docs: minor fixes in the docstrings for Cutout (#410)
Browse files Browse the repository at this point in the history
  • Loading branch information
lumbric authored Nov 21, 2024
1 parent 2d4504c commit a6e7fbb
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions atlite/cutout.py
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,8 @@ def __init__(self, path, **cutoutparams):
Frequency of the time coordinate. The default is 'h'. Valid are all
pandas offset aliases.
chunks : dict
Chunks when opening netcdf files. For cutout preparation recommand
to chunk only along the time dimension. Defaults to {'time': 20}
Chunks when opening NetCDF files. For cutout preparation it is recommended
to chunk only along the time dimension. Defaults to {'time': 100}
data : xr.Dataset
User provided cutout data. Save the cutout using `Cutout.to_file()`
afterwards.
Expand All @@ -131,7 +131,7 @@ def __init__(self, path, **cutoutparams):
sarah data which has missing data for areas where dawn and
nightfall happens (ca. 30 min gap).
gebco_path: str
Path to find the gebco netcdf file. Only necessary when including
Path to find the gebco NetCDF file. Only necessary when including
the gebco module.
parallel : bool, default False
Whether to open dataset in parallel mode. Take effect for all
Expand Down Expand Up @@ -440,7 +440,7 @@ def merge(self, other, path=None, **kwargs):

def to_file(self, fn=None):
"""
Save cutout to a netcdf file.
Save cutout to a NetCDF file.
Parameters
----------
Expand Down

0 comments on commit a6e7fbb

Please sign in to comment.