Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: minor fixes in the docstrings for Cutout #410

Merged
merged 1 commit into from
Nov 21, 2024
Merged

docs: minor fixes in the docstrings for Cutout #410

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions atlite/cutout.py
View file
Open in desktop
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