replace _prepare_3d_data with _prepare_simulated_data

Author: SarahAlidoost

PyStemmusScope/save.py

@@ -142,8 +142,8 @@ def _prepare_soil_data(file_name: str, var_name: str, time: List) -> xr.DataArra
     return data_array
 
 
-def _prepare_3d_data(file_name: str, model_name: str, alma_name: str, time: List) ->  xr.DataArray:
-    """Reshape a `pandas.DataFrame` to include z dimension.
+def _prepare_simulated_data(file_name: str, model_name: str, alma_name: str, time: List) ->  xr.DataArray:
+    """Return model simulation as `xr.DataArray`.
 
     Args:
         file_name(str): csv file name generated by Stemmus_Scope model.
@@ -305,7 +305,7 @@ def to_netcdf(config: Dict, cf_filename: str) -> str:
         elif alma_name in {"SoilTemp", "SoilMoist"}:
             data_array = _prepare_soil_data(file_name, alma_name, time.values)
         else:
-            data_array = _prepare_3d_data(
+            data_array = _prepare_simulated_data(
                 file_name, df["Variable name in STEMMUS-SCOPE"], alma_name, time.values
                 )
 

tests/test_save.py

@@ -85,7 +85,7 @@ def test_save_to_netcdf(self, cf_convention, model_with_setup):
         assert "z" not in dataset
 
 
-class TestSave3dData:
+class TestSaveSimulatedData:
     @pytest.fixture
     def cf_convention(self, tmp_path):
         convention = [