Add read_trpdataset as alias

Meng's original func name

monetio/sat/_tropomi_l2_no2_mm.py

@@ -9,6 +9,7 @@
 import logging
 import os
 import sys
+import warnings
 from collections import OrderedDict
 from datetime import datetime
 from glob import glob
@@ -195,7 +196,8 @@ def apply_quality_flag(ds):
 
 
 def open_dataset(fnames, variable_dict, debug=False):
-    """
+    """Open one or more TROPOMI L2 NO2 files.
+
     Parameters
     ----------
     fnames : str
@@ -259,3 +261,13 @@ def open_dataset(fnames, variable_dict, debug=False):
             granules[key] = [granule]
 
     return granules
+
+
+def read_trpdataset(*args, **kwargs):
+    """Alias for :func:`open_dataset`."""
+    warnings.warn(
+        "read_trpdataset is an alias for open_dataset and may be removed in the future",
+        FutureWarning,
+        stacklevel=2,
+    )
+    return open_dataset(*args, **kwargs)

tests/test_tropomi_l2.py

@@ -7,7 +7,7 @@
 import pytest
 from filelock import FileLock
 
-from monetio.sat._tropomi_l2_no2_mm import open_dataset
+from monetio.sat._tropomi_l2_no2_mm import open_dataset, read_trpdataset
 
 HERE = Path(__file__).parent
 
@@ -63,6 +63,10 @@ def test_open_dataset(test_file_path):
 
     ds = open_dataset(test_file_path, vn)[KEY][0]
 
+    with pytest.warns(FutureWarning, match="read_trpdataset is an alias"):
+        ds_alias = read_trpdataset(test_file_path, vn)[KEY][0]
+    assert ds_alias.identical(ds)
+
     assert set(ds.coords) == {"time", "lat", "lon", "scan_time"}
     assert set(ds) == {vn}