From 54c8b7cd1c1399da306dda643a3f52bde96ac3bb Mon Sep 17 00:00:00 2001 From: Braden Date: Mon, 18 Mar 2024 16:18:26 -0600 Subject: [PATCH] Added docstring --- opencsp/app/sofast/lib/ProcessSofastFringe.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/opencsp/app/sofast/lib/ProcessSofastFringe.py b/opencsp/app/sofast/lib/ProcessSofastFringe.py index 0ff82086b..29f04166c 100644 --- a/opencsp/app/sofast/lib/ProcessSofastFringe.py +++ b/opencsp/app/sofast/lib/ProcessSofastFringe.py @@ -737,6 +737,15 @@ def get_optic( return facets[0] def save_to_hdf(self, file: str, prefix: str = ''): + """Saves data to given file. Data is stored as: PREFIX + Folder/Field_1 + + Parameters + ---------- + file : str + HDF file to save to + prefix : str + Prefix to append to folder path within HDF file (folders must be separated by "/") + """ # Log lt.info(f'Saving SofastFringe data to: {file:s}, in HDF5 folder: "{prefix:s}"')