Skip to content

Commit

Permalink
docs(dataset): add missing module docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
wvenialbo committed Oct 25, 2024
1 parent 0620f0e commit 8cb4137
Show file tree
Hide file tree
Showing 6 changed files with 45 additions and 0 deletions.
8 changes: 8 additions & 0 deletions src/GOES_DL/dataset/base/locator_gg.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
"""
Provide GridSat or GOES-R series dataset product locator.
Classes:
- ProductLocatorGG: Abstract a GridSat or GOES-R series dataset
product locator.
"""

from abc import abstractmethod
from datetime import datetime, timezone
from re import Match, findall, fullmatch
Expand Down
7 changes: 7 additions & 0 deletions src/GOES_DL/dataset/goes/constants.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
"""
Constants for GOES dataset file handling.
This module contains constants used for handling GOES dataset files,
including file suffixes, date formats, and date patterns.
"""

GOESR_FILE_SUFFIX: str = ".nc"

GOESR_FILE_DATE_FORMAT: str = "%Y%j%H%M%S%f"
Expand Down
7 changes: 7 additions & 0 deletions src/GOES_DL/dataset/goes/locator_abi.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
"""
Provide GOES-R Series imagery dataset's ABI product locator.
Classes:
- GOESProductLocatorABI: Locator for ABI products.
"""

from .locator import GOESProductLocator


Expand Down
8 changes: 8 additions & 0 deletions src/GOES_DL/dataset/goes/locator_dc.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
"""
Provide GOES-R Series imagery dataset's ABI product locator.
Classes:
- GOESProductLocatorABIDC: Locator for ABI products with derived
channel.
"""

from .locator_abi import GOESProductLocatorABI


Expand Down
7 changes: 7 additions & 0 deletions src/GOES_DL/dataset/gridsat/constants.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
"""
Constants for the GridSat dataset file handling.
This module contains constants used for processing GridSat dataset
files, including file suffixes, date formats, and product versions.
"""

GRIDSAT_FILE_SUFFIX: str = ".nc"

B1_FILE_DATE_FORMAT: str = "%Y.%m.%d.%H"
Expand Down
8 changes: 8 additions & 0 deletions src/GOES_DL/dataset/locator.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
"""
Provide product locator for satellite imagery dataset consumers.
Classes:
- ProductLocator: Abstract a product locator for satellite imagery
dataset consumers.
"""

from abc import ABC, abstractmethod
from datetime import datetime

Expand Down

0 comments on commit 8cb4137

Please sign in to comment.