More docstring work

Author: jacobbieker

ocf_datapipes/__init__.py

@@ -0,0 +1 @@
+"""Datapipes"""

ocf_datapipes/batch/__init__.py

@@ -1,3 +1,4 @@
+"""Datapipes for batching together data"""
 from .merge_numpy_examples_to_batch import (
     MergeNumpyExamplesToBatchIterDataPipe as MergeNumpyExamplesToBatch,
 )

ocf_datapipes/config/__init__.py

@@ -0,0 +1 @@
+"""Configuration model"""

ocf_datapipes/convert/__init__.py

@@ -1,3 +1,4 @@
+"""Various conversion datapipes"""
 from .coordinates import ConvertGeostationaryToLatLonIterDataPipe as ConvertGeostationaryToLatLon
 from .coordinates import ConvertLatLonToOSGBIterDataPipe as ConvertLatLonToOSGB
 from .coordinates import ConvertOSGBToLatLonIterDataPipe as ConvertOSGBToLatLon

ocf_datapipes/fake/__init__.py

@@ -0,0 +1 @@
+"""Fake data generators for testing"""

ocf_datapipes/load/__init__.py

@@ -1,3 +1,4 @@
+"""Loading datapipes from the raw data"""
 from .configuration import OpenConfigurationIterDataPipe as OpenConfiguration
 from .gsp import OpenGSPIterDataPipe as OpenGSP
 from .nwp import OpenNWPIterDataPipe as OpenNWP

ocf_datapipes/production/__init__.py

@@ -0,0 +1 @@
+"""Wrappers to make complete data pipelines for production systems"""

ocf_datapipes/select/__init__.py

@@ -1,3 +1,4 @@
+"""Selection datapipes"""
 from .location_picker import LocationPickerIterDataPipe as LocationPicker
 from .offset_t0 import OffsetT0IterDataPipe as OffsetT0
 from .select_live_t0_time import SelectLiveT0TimeIterDataPipe as SelectLiveT0Time

ocf_datapipes/transform/__init__.py

@@ -0,0 +1 @@
+"""Transforms for the data in both xarray and numpy formats"""

ocf_datapipes/transform/numpy/__init__.py

@@ -1,3 +1,4 @@
+"""Numpy transforms"""
 from .add_topographic_data import AddTopographicDataIterDataPipe as AddTopographicData
 from .align_gsp_to_5_min import AlignGSPto5MinIterDataPipe as AlignGSPto5Min
 from .encode_space_time import EncodeSpaceTimeIterDataPipe as EncodeSpaceTime

ocf_datapipes/transform/xarray/__init__.py

@@ -1,3 +1,4 @@
+"""Xarray transforms"""
 from .add_t0idx_and_sample_period_duration import (
     AddT0IdxAndSamplePeriodDurationIterDataPipe as AddT0IdxAndSamplePeriodDuration,
 )

ocf_datapipes/utils/__init__.py

@@ -0,0 +1 @@
+"""Various utilities for use in datapipes"""

ocf_datapipes/utils/utils.py

@@ -1,3 +1,4 @@
+"""Various utilites that didn't fit elsewhere"""
 from pathlib import Path
 from typing import Sequence, Union
 

ocf_datapipes/validation/check_equality.py

@@ -1,3 +1,4 @@
+"""Datapipes to check equalities"""
 import logging
 from typing import Optional, Union
 

ocf_datapipes/validation/check_for_nans.py

@@ -1,3 +1,4 @@
+"""Datapipe to check and optionally fill NaNs in data"""
 from typing import Union
 
 import numpy as np

ocf_datapipes/validation/check_statistical_properties.py

@@ -0,0 +1 @@
+"""Datapipe to check statistical properties of inputs"""

ocf_datapipes/validation/check_vars_and_dims.py

@@ -1,3 +1,4 @@
+"""Datapipe to check variable and dimension names exist"""
 from typing import Iterable, Optional, Union
 
 import xarray as xr