mt-metadata 0.3.7__py2.py3-none-any.whl → 0.3.8__py2.py3-none-any.whl

mt_metadata/__init__.py

@@ -39,7 +39,7 @@ you should only have to changes these dictionaries.
 
 __author__ = """Jared Peacock"""
 __email__ = "jpeacock@usgs.gov"
-__version__ = "0.3.7"
+__version__ = "0.3.8"
 
 # =============================================================================
 # Imports

mt_metadata/transfer_functions/core.py

@@ -274,7 +274,7 @@ class TF:
                 )
                 self.logger.error(msg)
                 raise TypeError(msg)
-        return run_metadata.copy()
+        return run_metadata
 
     def _validate_station_metadata(self, station_metadata):
         """
@@ -298,7 +298,7 @@ class TF:
                 )
                 self.logger.error(msg)
                 raise TypeError(msg)
-        return station_metadata.copy()
+        return station_metadata
 
     def _validate_survey_metadata(self, survey_metadata):
         """
@@ -328,7 +328,7 @@ class TF:
                 )
                 self.logger.error(msg)
                 raise TypeError(msg)
-        return survey_metadata.copy()
+        return survey_metadata
 
     ### Properties ------------------------------------------------------------
     @property
@@ -1475,9 +1475,8 @@ class TF:
         """
         self.station_metadata.id = validate_name(station_name)
         if self.station_metadata.runs[0].id is None:
-            r = self.station_metadata.runs[0].copy()
+            r = self.station_metadata.runs.pop(None)
             r.id = f"{self.station_metadata.id}a"
-            self.station_metadata.runs.remove(None)
             self.station_metadata.runs.append(r)
 
     @property
@@ -2164,9 +2163,9 @@ class TF:
         """
         zmm_kwargs = {}
         zmm_kwargs["channel_nomenclature"] = self.channel_nomenclature
-        zmm_kwargs[
-            "inverse_channel_nomenclature"
-        ] = self.inverse_channel_nomenclature
+        zmm_kwargs["inverse_channel_nomenclature"] = (
+            self.inverse_channel_nomenclature
+        )
         if hasattr(self, "decimation_dict"):
             zmm_kwargs["decimation_dict"] = self.decimation_dict
         zmm_obj = ZMM(**zmm_kwargs)

mt_metadata/transfer_functions/io/edi/edi.py

@@ -252,6 +252,22 @@ class EDI(object):
             return 1.0 / self.frequency
         return None
 
+    def _assert_descending_frequency(self):
+        """
+        Assert that the transfer function is ordered from high frequency to low
+        frequency.
+
+        """
+        if self.frequency[0] < self.frequency[1]:
+            self.logger.debug(
+                "Ordered arrays to be arranged from high to low frequency"
+            )
+            self.frequency = self.frequency[::-1]
+            self.z = self.z[::-1]
+            self.z_err = self.z_err[::-1]
+            self.t = self.t[::-1]
+            self.t_err = self.t_err[::-1]
+
     def read(self, fn=None, get_elevation=False):
         """
         Read in an edi file and fill attributes of each section's classes.
@@ -456,13 +472,8 @@ class EDI(object):
             except KeyError as error:
                 self.logger.debug(error)
         # check for order of frequency, we want high togit  low
-        if self.frequency[0] < self.frequency[1]:
-            self.logger.debug(
-                "Ordered arrays to be arranged from high to low frequency"
-            )
-            self.frequency = self.frequency[::-1]
-            self.z = self.z[::-1]
-            self.z_err = self.z_err[::-1]
+        self._assert_descending_frequency()
+
         try:
             self.rotation_angle = np.array(data_dict["zrot"])
         except KeyError:

mt_metadata/transfer_functions/processing/aurora/decimation_level.py

@@ -31,7 +31,7 @@ attr_dict.add_dict(get_schema("estimator", SCHEMA_FN_PATHS), "estimator")
 # =============================================================================
 
 
-def df_from_bands(band_list):
+def df_from_bands(band_list: list) -> pd.DataFrame:
     """
     Utility function that transforms a list of bands into a dataframe
 
@@ -70,13 +70,13 @@ def df_from_bands(band_list):
     out_df.reset_index(inplace=True, drop=True)
     return out_df
 
-def get_fft_harmonics(samples_per_window, sample_rate):
+def get_fft_harmonics(samples_per_window: int, sample_rate: float) -> np.ndarray:
     """
     Works for odd and even number of points.
 
-    Could be midified with kwargs to support one_sided, two_sided, ignore_dc
-    ignore_nyquist, and etc.  Could actally take FrequencyBands as an argument
-    if we wanted as well.
+    Development notes:
+    Could be modified with kwargs to support one_sided, two_sided, ignore_dc
+    ignore_nyquist, and etc.  Consider taking FrequencyBands as an argument.
 
     Parameters
     ----------

mt_metadata/utils/list_dict.py

@@ -44,18 +44,14 @@ class ListDict:
 
     def _get_key_from_index(self, index):
         try:
-            return next(
-                key for ii, key in enumerate(self._home) if ii == index
-            )
+            return next(key for ii, key in enumerate(self._home) if ii == index)
 
         except StopIteration:
             raise KeyError(f"Could not find {index}")
 
     def _get_index_from_key(self, key):
         try:
-            return next(
-                index for index, k in enumerate(self._home) if k == key
-            )
+            return next(index for index, k in enumerate(self._home) if k == key)
 
         except StopIteration:
             raise KeyError(f"Could not find {key}")
@@ -75,9 +71,7 @@ class ListDict:
         elif hasattr(obj, "component"):
             return obj.component
         else:
-            raise TypeError(
-                "could not identify an appropriate key from object"
-            )
+            raise TypeError("could not identify an appropriate key from object")
 
     def __deepcopy__(self, memodict={}):
         """
@@ -230,9 +224,7 @@ class ListDict:
                 raise (KeyError("Could not find None in keys."))
 
         else:
-            raise TypeError(
-                "could not identify an appropriate key from object"
-            )
+            raise TypeError("could not identify an appropriate key from object")
 
     def extend(self, other, skip_keys=[]):
         """
@@ -282,3 +274,18 @@ class ListDict:
             )
 
         self._home.update(other)
+
+    def pop(self, key):
+        """
+        pop item off of dictionary.  The key must be verbatim
+
+        :param key: key of item to be popped off of dictionary
+        :type key: string
+        :return: item popped
+
+        """
+
+        if key in self.keys():
+            return dict([self._home.popitem(key)])
+        else:
+            raise KeyError(f"{key} is not in ListDict keys.")

{mt_metadata-0.3.7.dist-info → mt_metadata-0.3.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mt-metadata
-Version: 0.3.7
+Version: 0.3.8
 Summary: Metadata for magnetotelluric data
 Home-page: https://github.com/kujaku11/mt_metadata
 Author: Jared Peacock
@@ -28,7 +28,7 @@ Requires-Dist: matplotlib
 Requires-Dist: xarray
 Requires-Dist: loguru
 
-# mt_metadata version 0.3.7
+# mt_metadata version 0.3.8
  Standard MT metadata
 
 [![PyPi version](https://img.shields.io/pypi/v/mt_metadata.svg)](https://pypi.python.org/pypi/mt-metadata)
@@ -58,7 +58,7 @@ MT Metadata is a project led by [IRIS-PASSCAL MT Software working group](https:/
 
 Most people will be using the transfer functions, but a lot of that metadata comes from the time series metadata.  This module supports both and has tried to make them more or less seamless to reduce complication.
 
-* **Version**: 0.3.7
+* **Version**: 0.3.8
 * **Free software**: MIT license
 * **Documentation**: https://mt-metadata.readthedocs.io.
 * **Examples**: Click the `Binder` badge above and Jupyter Notebook examples are in **mt_metadata/examples/notebooks** and **docs/source/notebooks**
@@ -426,3 +426,11 @@ History
 * Patches by @kkappler in https://github.com/kujaku11/mt_metadata/pull/221
 * Patches by @kkappler in https://github.com/kujaku11/mt_metadata/pull/223
 * Bump version: 0.3.6 → 0.3.7 by @kujaku11 in https://github.com/kujaku11/mt_metadata/pull/225 
+
+0.3.8 (2024-09-30)
+----------------------
+
+* Add pop to ListDict by @kujaku11 in https://github.com/kujaku11/mt_metadata/pull/226
+* Fix EDI Tipper flip by @kujaku11 in https://github.com/kujaku11/mt_metadata/pull/228
+* Patches by @kujaku11 in https://github.com/kujaku11/mt_metadata/pull/227
+* Bump version: 0.3.7 → 0.3.8 by @kujaku11 in https://github.com/kujaku11/mt_metadata/pull/229 

{mt_metadata-0.3.7.dist-info → mt_metadata-0.3.8.dist-info}/RECORD

@@ -1,4 +1,4 @@
-mt_metadata/__init__.py,sha256=Ij-OA6uOFAAYRMgD-lPkuf74v6_J326Orxlg2fKQVbM,5588
+mt_metadata/__init__.py,sha256=5I6-LAuYEnG5odhwSnzJQmi38FjQCSeUoBpwML7C6BI,5588
 mt_metadata/base/__init__.py,sha256=bylCGBoJkeytxeQgMnuqivqFAvbyNE5htvP-3yu1GEY,184
 mt_metadata/base/helpers.py,sha256=_SbJC8zDFmjQrmGbb6jBkqkWtaItNHyb8PREdPm5nl8,19798
 mt_metadata/base/metadata.py,sha256=obOFdU6FPf2o-SbdxOxZ60LvzbI6Cp-bbRXw8KdkBao,27145
@@ -131,11 +131,11 @@ mt_metadata/timeseries/stationxml/xml_station_mt_station.py,sha256=pelvkiQios4gz
 mt_metadata/timeseries/tools/__init__.py,sha256=loPgjYnajbOX2rQTlLBh79cG2eaUNpI3KaCjp7SB4ik,78
 mt_metadata/timeseries/tools/from_many_mt_files.py,sha256=rtx5NAPBUmOgrMXUT-YJxznqfI1qdRkS4B2SWjrU_1c,14405
 mt_metadata/transfer_functions/__init__.py,sha256=7F_9sev0KlRfswx_H0j8-1PJs-ZTpD04qwjYh1jst8w,1288
-mt_metadata/transfer_functions/core.py,sha256=AmWmH2-k-2W2uGTsaozZkq6p3KURWWgfMHCbEMZiTU8,80641
+mt_metadata/transfer_functions/core.py,sha256=9fl-9-9x0vUMIv9MdiR-cp90ImJsS5E9NYTdkjvRaos,80569
 mt_metadata/transfer_functions/io/__init__.py,sha256=8DKEQZrpF0RK_MTjR0_w0UQfgVf9VwuJrzy7eann1N8,215
 mt_metadata/transfer_functions/io/tools.py,sha256=xatyc0RN8-KKS1PmpjATDAOHln9HIEP-iNAN0Njjyv4,6024
 mt_metadata/transfer_functions/io/edi/__init__.py,sha256=5pgyFFwRezvlxxcsSQsvCmeShJe97TdY6F37T7FiNWA,61
-mt_metadata/transfer_functions/io/edi/edi.py,sha256=mFUahyjiIZnh45masDsue4pJkU4FifnZOi4I8rlvXh0,53798
+mt_metadata/transfer_functions/io/edi/edi.py,sha256=BQdiZNiXRdQ9-95HhhWDNK4zHyUTSFRcHXSJr4h6Q8I,54099
 mt_metadata/transfer_functions/io/edi/metadata/__init__.py,sha256=ndXcOh7eN4adnXS7fAtvZg6i4K_gY3VT7zbNzeGjsaM,395
 mt_metadata/transfer_functions/io/edi/metadata/data_section.py,sha256=RhelbBN83LhRvItlVrBKuQoFLBaPonENp0KyIkW79X0,7751
 mt_metadata/transfer_functions/io/edi/metadata/define_measurement.py,sha256=AQfJQSTVs-iOuEyiCnBFjMwqgowD0dkL2Bp5mSAhQ8s,16318
@@ -280,7 +280,7 @@ mt_metadata/transfer_functions/processing/aurora/band.py,sha256=mNDkpJQbf7F7aF-F
 mt_metadata/transfer_functions/processing/aurora/channel.py,sha256=TZHfy-XgrijdNVd4Sjbq3tjORFsJNZIzwa4_J7tDOHM,773
 mt_metadata/transfer_functions/processing/aurora/channel_nomenclature.py,sha256=Y7rQTH3YsTB8KFIMk6vQZWFrRKQWlnwoQNZOZjZImbk,3038
 mt_metadata/transfer_functions/processing/aurora/decimation.py,sha256=AF7vdU-Q7W4yfnJoPDbhDqgxJTtHiLCLEUDLBEzfmFM,785
-mt_metadata/transfer_functions/processing/aurora/decimation_level.py,sha256=cZhV9BPM7kj3qSDg7HCM2vyV7VW1-jWOTE7ISASKRsA,10657
+mt_metadata/transfer_functions/processing/aurora/decimation_level.py,sha256=-DgKDCypO1qoqYsck-FNGrduF41can3xqRLsKeIVYeA,10700
 mt_metadata/transfer_functions/processing/aurora/estimator.py,sha256=9I2Rs3guO7sc9HEpLbYI8nYZfQ7IayosKvsrE6etBac,781
 mt_metadata/transfer_functions/processing/aurora/processing.py,sha256=BCKXGu_iVValVyE0EbsR9_gYkwv0I4GxS61AqXUtc8s,10320
 mt_metadata/transfer_functions/processing/aurora/regression.py,sha256=NIgivJx11-ZVsVfQgdIODfsPeyMPmhRXA6bSNiarA8c,783
@@ -325,14 +325,14 @@ mt_metadata/transfer_functions/tf/standards/survey.json,sha256=4AX3-n8j8QwLkXF7G
 mt_metadata/transfer_functions/tf/standards/transfer_function.json,sha256=yTPACcTk9JcxmTwIiRPUdoPf3riRGJZ-XxrNfHU5Otw,3220
 mt_metadata/utils/__init__.py,sha256=5TWhar2ujJY_pYkwDdggX8jU9CFXcxc9jX1yXc8TqJs,35
 mt_metadata/utils/exceptions.py,sha256=PKWdjKfR95NJ-Rgx3rzu9Qmdj0thVHjcmEvHoC9HuBE,462
-mt_metadata/utils/list_dict.py,sha256=BguxnQuNPf8aOMwULaaam22L4RUQ3SNzIkLqVh_gUQs,7668
+mt_metadata/utils/list_dict.py,sha256=sazYtq8spfN9l6iGrqsfKCdUFAMXq6iV8cq3m8UlS-Q,7945
 mt_metadata/utils/mttime.py,sha256=v71TCPjtoY_0GTsJ39WCD8kwIZDNzE679m96a3QGgPE,18725
 mt_metadata/utils/summarize.py,sha256=KisJt2PWz1-_FOBH8NQtidgxjdWPAbIDwPzEB197uhs,4109
 mt_metadata/utils/units.py,sha256=OdALLmytoPvjJ8rYf7QsGq1b8nrNt85A8wUhjqRyTOo,6405
 mt_metadata/utils/validators.py,sha256=jQf0VBtfT5GMXlEUI5Hg1zILqSir9Ra4Moi4dL54KeM,16380
-mt_metadata-0.3.7.dist-info/AUTHORS.rst,sha256=3RKy4std2XZQLNF6xYIiA8S5A0bBPqNO7ypJsuEhiN8,706
-mt_metadata-0.3.7.dist-info/LICENSE,sha256=P33RkFPriIBxsgZtVzSn9KxYa2K7Am42OwMV0h_m5e0,1080
-mt_metadata-0.3.7.dist-info/METADATA,sha256=dCuqaycFVp396z1u2LdlwnYTOI36qMNpu5i8sfk8_vI,20438
-mt_metadata-0.3.7.dist-info/WHEEL,sha256=DZajD4pwLWue70CAfc7YaxT1wLUciNBvN_TTcvXpltE,110
-mt_metadata-0.3.7.dist-info/top_level.txt,sha256=fxe_q_GEd9h6iR3050ZnrhSfxUSO5pR8u65souS4RWM,12
-mt_metadata-0.3.7.dist-info/RECORD,,
+mt_metadata-0.3.8.dist-info/AUTHORS.rst,sha256=3RKy4std2XZQLNF6xYIiA8S5A0bBPqNO7ypJsuEhiN8,706
+mt_metadata-0.3.8.dist-info/LICENSE,sha256=P33RkFPriIBxsgZtVzSn9KxYa2K7Am42OwMV0h_m5e0,1080
+mt_metadata-0.3.8.dist-info/METADATA,sha256=n5-YN8vl3N_p8nBp_EUFXxSC97d-rXWmHwGa5BaIolM,20842
+mt_metadata-0.3.8.dist-info/WHEEL,sha256=DZajD4pwLWue70CAfc7YaxT1wLUciNBvN_TTcvXpltE,110
+mt_metadata-0.3.8.dist-info/top_level.txt,sha256=fxe_q_GEd9h6iR3050ZnrhSfxUSO5pR8u65souS4RWM,12
+mt_metadata-0.3.8.dist-info/RECORD,,