From 95fe217995e96b6ab32520808c4ba21fe4c477fa Mon Sep 17 00:00:00 2001 From: Gaute Hope Date: Wed, 9 Oct 2024 10:48:42 +0200 Subject: [PATCH] doc: assign_attrs --- trajan/traj.py | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/trajan/traj.py b/trajan/traj.py index c6468af..6b80b94 100644 --- a/trajan/traj.py +++ b/trajan/traj.py @@ -308,15 +308,27 @@ def assign_cf_attrs(self, Parameters ---------- - *kwargs - Attribute names and values + creator_name : string + Creator of dataset (optional). + + creator_email : string + Creator email (optional). + + title : string + Title of dataset (optional). + + summary : string + Description of dataset (optional). + + *kwargs : dict + Additional attribute key and values (optional). Returns ------- Dataset Updated dataset with provided attributes, in addition to several CF standard attributes, including Conventions, featureType, geospatial_lat_min etc. - + """ ds = self.ds.copy(deep=True) @@ -407,7 +419,7 @@ def time_to_next(self) -> pd.Timedelta: Returns ------- DataArray - Scalar timedelta for 1D objects (fixed timestep), and DataArray of same size as input for 2D objects + Scalar timedelta for 1D objects (fixed timestep), and DataArray of same size as input for 2D objects See Also --------