Refactoring

.gitignore

@@ -142,3 +142,4 @@ __main__.py
 *.csv
 *.json
 *.png
+!x1.zarr

echoregions/__init__.py

@@ -1,12 +1,3 @@
-from .convert.api import read_evl, read_evr
-from .convert.utils import parse_simrad_fname_time, parse_time
-from .formats import Lines, Regions2D
+from .core import read_evl, read_evr
 
-__all__ = [
-    "read_evl",
-    "read_evr",
-    "parse_simrad_fname_time",
-    "parse_time",
-    "Lines",
-    "Regions2D",
-]
+__all__ = ["read_evl", "read_evr"]

echoregions/core.py

@@ -0,0 +1,42 @@
+from .lines.lines import Lines
+from .regions2d.regions2d import Regions2D
+
+
+def read_evr(
+    filepath: str, min_depth: float = None, max_depth: float = None
+) -> Regions2D:
+    """Read an EVR file into a Regions2D object.
+
+    Parameters
+    ----------
+    filepath : str, Path object
+        A valid path to an EVR file
+    min_depth : float, default ``None``
+        Depth value in meters to set -9999.99 depth edges to.
+    max_depth : float, default ``None``
+        Depth value in meters to set 9999.99 depth edges to.
+
+    Returns
+    -------
+    Regions2D
+        Object that contains the EVR data and metadata with methods for saving to file.
+    """
+    return Regions2D(input_file=str(filepath), min_depth=min_depth, max_depth=max_depth)
+
+
+def read_evl(filepath: str, nan_depth_value: float = None) -> Lines:
+    """Read an EVL file into a Lines object.
+
+    Parameters
+    ----------
+    filepath : str, Path object
+        A valid path to an EVL file
+    nan_depth_value : float, default ``None``
+        Depth in meters to replace -10000.990000 ranges with.
+
+    Returns
+    -------
+    Lines
+        Object that contains EVL data and metadata with methods for saving to file.
+    """
+    return Lines(input_file=str(filepath), nan_depth_value=nan_depth_value)