rapidtide 3.0.11__py3-none-any.whl → 3.1.1__py3-none-any.whl

rapidtide/workflows/tcfrom3col.py

@@ -17,14 +17,40 @@
 #
 #
 import argparse
+from argparse import Namespace
+from typing import Any, Callable, Dict, List, Optional, Tuple, Union
 
 import numpy as np
+from numpy.typing import NDArray
 
 import rapidtide.io as tide_io
 import rapidtide.util as tide_util
 
 
-def _get_parser():
+def _get_parser() -> Any:
+    """
+    Create and configure argument parser for command line interface.
+
+    This function initializes an ArgumentParser object with specific parameters
+    required for processing three-column data files and generating time course output.
+
+    Returns
+    -------
+    argparse.ArgumentParser
+        Configured argument parser object with all required and optional arguments
+
+    Notes
+    -----
+    The parser expects exactly four positional arguments followed by an optional
+    debug flag. The function is designed for use with the tcfrom3col program.
+
+    Examples
+    --------
+    >>> parser = _get_parser()
+    >>> args = parser.parse_args(['input.txt', '0.1', '100', 'output.txt'])
+    >>> print(args.infilename)
+    'input.txt'
+    """
     # get the command line parameters
     parser = argparse.ArgumentParser(
         prog="tcfrom3col",
@@ -48,7 +74,53 @@ def _get_parser():
     return parser
 
 
-def tcfrom3col(args):
+def tcfrom3col(args: Any) -> None:
+    """
+    Convert three-column data to tidal constituent data.
+
+    This function reads three-column input data, processes it to extract tidal constituents,
+    and writes the results to an output file. The input data is expected to contain time,
+    latitude, and longitude columns, and the output contains tidal constituent information.
+
+    Parameters
+    ----------
+    args : Any
+        An object containing the following attributes:
+        - infilename : str
+            Path to the input file containing three-column data
+        - outfilename : str
+            Path to the output file for writing tidal constituent data
+        - numpoints : int
+            Number of data points in the time series
+        - timestep : float
+            Time step between data points
+        - debug : bool
+            Flag to enable debug printing
+
+    Returns
+    -------
+    None
+        This function does not return a value but writes output to a file.
+
+    Notes
+    -----
+    The function uses `tide_io.readvecs` to read input data and `tide_util.maketcfrom3col`
+    to perform the tidal constituent calculation. The time axis is generated using
+    `np.arange` with the specified number of points and time step.
+
+    Examples
+    --------
+    >>> class Args:
+    ...     def __init__(self):
+    ...         self.infilename = 'input.dat'
+    ...         self.outfilename = 'output.dat'
+    ...         self.numpoints = 1000
+    ...         self.timestep = 3600.0
+    ...         self.debug = False
+    ...
+    >>> args = Args()
+    >>> tcfrom3col(args)
+    """
     if args.debug:
         print(args)