add docstrings to __init__.py

ocean_data_parser/batch/__init__.py

@@ -0,0 +1,12 @@
+"""This module contains the batch processing functions for the ocean data parser.
+
+Modules:
+    - __init__.py: Initializes the batch package.
+    - convert.py: Contains functions to convert multiple files at once.
+    - utils.py: Contains utility functions for batch processing.
+    - registry.py: Contains the registry for batch processing functions.
+    - config.py: Contains functions to load configuration files.
+    - default-batch-config.json: Default configuration file for batch processing.
+
+The batch package is responsible for managing and processing multiple files at once.
+"""

ocean_data_parser/metadata/__init__.py

@@ -0,0 +1,11 @@
+"""This package contains modules related to metadata used in the ocean data parser.
+
+Modules:
+    - __init__.py: Initializes the metadata package.
+    - cf.py: Contains functions to load CF metadata standard names.
+    - nerc.py: Contains functions to load NERC metadata standard names.
+    - pdc.py: Contains functions to convert PDC metadata standard names
+        to the ACDD 1.3 standard format.
+
+The metadata package is responsible for managing and parsing various metadata
+"""

ocean_data_parser/parsers/__init__.py

@@ -1 +1 @@
-
+"""This package contains all the parsers used in the ocean data parser."""

ocean_data_parser/parsers/dfo/__init__.py

@@ -1,2 +1,13 @@
+"""This package contains all the parsers related to the Fisheries and Ocean Canada standard formats.
+
+Modules:
+    - __init__.py: Initializes the parsers package.
+    - ios.py: Contains functions to parse the DFO-IOS office file formats.
+    - nafc.py: Contains functions to parse DFO-NAFC office file formats.
+    - odf.py: Contains functions to parse the ODF file format used at
+        the DFO-BIO and DFO-IML offices.
+
+"""
+
 __all__ = ["ios", "nafc", "odf"]
 from . import ios, nafc, odf

ocean_data_parser/parsers/dfo/ios_source/__init__.py

@@ -0,0 +1 @@
+"""This module contains the parsers for the Institute of Ocean Sciences (IOS) file formats."""

ocean_data_parser/parsers/dfo/odf_source/__init__.py

@@ -0,0 +1 @@
+"""This package contains all the parsers related to the Fisheries and Ocean Canada ODF standard format."""

ocean_data_parser/process/__init__.py

@@ -0,0 +1 @@
+"""This package contains modules related to processing oceanographic data."""

ocean_data_parser/tools/__init__.py

@@ -0,0 +1,2 @@
+"""This package a series of tools used by the ocean_data_parser package."""
+"""

ocean_data_parser/vocabularies/__init__.py

@@ -0,0 +1,11 @@
+"""This package contains modules related to vocabularies used in the ocean data parser.
+
+Modules:
+    - __init__.py: Initializes the vocabularies package.
+    - load.py: Contains functions to load vocabularies from various sources.
+    - *.json or *.csv: Vocabulary files containing terms and definitions
+        used by each specific parsers.
+
+The vocabularies package is responsible for managing and
+parsing various vocabulariesnused in oceanographic data processing.
+"""

tests/__init__.py

@@ -0,0 +1,11 @@
+"""This package contains all the difrent tests to be run on the ocean_data_parser package.
+
+Modules:
+    test_*.py: Contains the tests for each module in the ocean_data_parser package.
+    parsers_test_files/: Contains the test files used by the tests.
+    batch_test_config/: Contains the configuration files for the batch tests.
+
+
+The tests package is responsible for testing the ocean_data_parser package during
+the continuous integration process.
+"""