Add docs for netcdf validation

Author: gislawill

DiveDB/services/data_uploader.py

@@ -235,7 +235,7 @@ def _write_event_to_duckpond(
         del batch_table
         gc.collect()
 
-    def _validate_netcdf(self, ds: xr.Dataset):
+    def validate_netcdf(self, ds: xr.Dataset):
         """
         Validates netCDF file before upload.
 

README.md

@@ -116,6 +116,9 @@ For any files to be uploaded to the data lake, they must be in netCDF format and
   Requires a labeling dimension.
   Attribute: variables with the variables' names (duplicates the dimension).
 
+**Validation:**
+- We have a validation function in `DataUploader.validate_netcdf` that checks if a netCDF file meets the above requirements and provides helpful error messages if not. See [validate_netcdf in data_uploader.py](DiveDB/services/data_uploader.py).
+
 **Example:**
 - A sample netCDF file is included in the repository: `oror-002_2024-01-16.nc` that meets the above requirements and can be used as a template for your own data.
 

tests/services/test_data_uploader.py

@@ -35,7 +35,7 @@ def valid_netcdf_dataset():
 def test_validate_data_valid(valid_netcdf_dataset):
     uploader = DataUploader()
     ds = valid_netcdf_dataset
-    assert uploader._validate_netcdf(ds)
+    assert uploader.validate_netcdf(ds)
 
 
 def test_validate_data_invalid(valid_netcdf_dataset):
@@ -44,4 +44,4 @@ def test_validate_data_invalid(valid_netcdf_dataset):
     ds = ds.rename({"sensor_samples": "sensor"})
 
     with pytest.raises(NetCDFValidationError):
-        uploader._validate_netcdf(ds)
+        uploader.validate_netcdf(ds)