mt-metadata 1.0.0__tar.gz

mt_metadata-1.0.0/AUTHORS.rst

@@ -0,0 +1,20 @@
+=======
+Credits
+=======
+
+This project is in cooperation with the Incorporated Research Institutes of Seismology (IRIS), the U.S. Geological Survey (USGS), and other collaborators.  Facilities of the IRIS Consortium are supported by the National Science Foundation’s Seismological Facilities for the Advancement of Geoscience (SAGE) Award under Cooperative Support Agreement EAR-1851048.  USGS is partially funded through the Community for Data Integration and IMAGe through the Minerals Resources Program.  
+
+Development Lead
+----------------
+
+* Jared Peacock <jpeacock@usgs.gov>
+
+Contributors
+------------
+
+* Anna Kelbert
+* Karl Kappler
+* Lindsey Heagy
+* Andy Frassetto
+* Tim Ronan
+

mt_metadata-1.0.0/CONTRIBUTING.rst

@@ -0,0 +1,128 @@
+.. highlight:: shell
+
+============
+Contributing
+============
+
+Contributions are welcome, and they are greatly appreciated! Every little bit
+helps, and credit will always be given.
+
+You can contribute in many ways:
+
+Types of Contributions
+----------------------
+
+Report Bugs
+~~~~~~~~~~~
+
+Report bugs at https://github.com/kujaku11/mt_metadata/issues.
+
+If you are reporting a bug, please include:
+
+* Your operating system name and version.
+* Any details about your local setup that might be helpful in troubleshooting.
+* Detailed steps to reproduce the bug.
+
+Fix Bugs
+~~~~~~~~
+
+Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
+wanted" is open to whoever wants to implement it.
+
+Implement Features
+~~~~~~~~~~~~~~~~~~
+
+Look through the GitHub issues for features. Anything tagged with "enhancement"
+and "help wanted" is open to whoever wants to implement it.
+
+Write Documentation
+~~~~~~~~~~~~~~~~~~~
+
+mt_metadata could always use more documentation, whether as part of the
+official mt_metadata docs, in docstrings, or even on the web in blog posts,
+articles, and such.
+
+Submit Feedback
+~~~~~~~~~~~~~~~
+
+The best way to send feedback is to file an issue at https://github.com/kujaku11/mt_metadata/issues.
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that contributions
+  are welcome :)
+
+Get Started!
+------------
+
+Ready to contribute? Here's how to set up `mt_metadata` for local development.
+
+1. Fork the `mt_metadata` repo on GitHub.
+2. Clone your fork locally::
+
+    $ git clone git@github.com:your_name_here/mt_metadata.git
+
+3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
+
+    $ mkvirtualenv mt_metadata
+    $ cd mt_metadata/
+    $ python setup.py develop
+
+4. Create a branch for local development::
+
+    $ git checkout -b name-of-your-bugfix-or-feature
+
+   Now you can make your changes locally.
+
+5. When you're done making changes, check that your changes pass flake8 and the
+   tests, including testing other Python versions with tox::
+
+    $ flake8 mt_metadata tests
+    $ python setup.py test or pytest
+    $ tox
+
+   To get flake8 and tox, just pip install them into your virtualenv.
+
+6. Commit your changes and push your branch to GitHub::
+
+    $ git add .
+    $ git commit -m "Your detailed description of your changes."
+    $ git push origin name-of-your-bugfix-or-feature
+
+7. Submit a pull request through the GitHub website.
+
+Pull Request Guidelines
+-----------------------
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests.
+2. If the pull request adds functionality, the docs should be updated. Put
+   your new functionality into a function with a docstring, and add the
+   feature to the list in README.rst.
+3. The pull request should work for Python 3.5, 3.6, 3.7 and 3.8, and for PyPy. Check
+   https://travis-ci.com/kujaku11/mt_metadata/pull_requests
+   and make sure that the tests pass for all supported Python versions.
+
+Tips
+----
+
+To run a subset of tests::
+
+$ pytest tests.test_mt_metadata
+
+
+Deploying
+---------
+
+A reminder for the maintainers on how to deploy.
+Make sure all your changes are committed (including an entry in HISTORY.rst).
+Then run::
+
+$ bump2version patch # possible: major / minor / patch
+$ git push
+$ git push --tags
+
+Travis will then deploy to PyPI if tests pass.

mt_metadata-1.0.0/HISTORY.rst

@@ -0,0 +1,238 @@
+History
+=========
+
+
+0.1.0 (2020-12-30)
+------------------
+
+* First release on PyPI.
+
+0.1.3 (2021-06-25)
+-------------------
+
+* Added time series filters
+
+ - PoleZeroFilter
+ - CoefficientFilter
+ - FIRFilter
+ - TimeDelayFilter
+ - FrequencyAmplitudePhaseFilter
+
+* Added translations to/from StationXML
+* Updated tests
+* Fixed minor bugs
+* Updated documentation	
+
+0.1.5 (2021-11-13)
+-------------------
+
+* Bug fixes
+* Updated how units are handled
+* If survey.id is None set it to fdsn.network if available (mainly an IRIS DMC fix)
+* Updated translation of Experiment to StationXML
+* Updated tests
+
+0.1.6 (2021-12-07)
+--------------------
+
+* Bug fixes (mainly in mt_metadata.timeseries.filters)
+* Updated tests
+* Channel codes are handled "better"
+* Updating translation between Experiment and StationXML
+* Updated how filters are plotted
+* Adding notebooks to documentation
+
+0.1.7 (2022-01-10)
+--------------------
+
+* Updating how transfer functions are handled
+* Added readers and metadata standards for
+    - EDI files
+	- Z-files 
+	- J-Files
+	- AVG file
+	- EMTF XML files
+* Added tests for transfer functions
+* Updated mt_metadata.transfer_functions.core.TF
+* Added documentation on transfer functions
+
+0.1.8 (2022-04-07)
+--------------------
+
+* Bug fixes (mainly in the transfer functions)
+* Combined timeseries and transfer_function metadata where similar, so now transfer_function metadata imports from timeseries when applicable.  Reduces files and redundancy.
+* Updated documentation
+
+0.2.0 (2022-09-10)
+---------------------
+
+* minor bug fixes
+* update reading .AVG files
+
+0.2.1 (2023-01-18)
+---------------------
+
+* Update setup.py 
+* updating reading emtfxml files 
+* Fix issue 95 
+* Add model error 
+* Make sure filter names are unique 
+* Fix Empty Z file
+* Add metadata 
+* added test for multiple networks in stationxml 
+* updating to make mth5 work with single metadata object in ChannelTS and RunTS 
+* added test for null channel component 
+* Mth5 patch129 fixes 
+* Update edi.py 
+* add a line to allow aux channel component to be empty 
+* Update edi.py 
+* Mth5 patch129 fixes
+
+0.2.2 (2023-02-17)
+--------------------- 
+
+* Fixed bug in Station.channels_recorded when a string is input
+
+0.2.3 (2023-04-24)
+---------------------
+
+* Add methods for t0/from transfer function file type 
+* Update when an np.datetime64 is input 
+* MTime update to handle nanosecond accuracy 
+* MTime and pandas Timestamp cannot handle large future or past dates 
+* Fix input time with `isoformat` attribute
+* updating if a timedelta is subtracted 
+* Updates from main into fix_issue_133
+* Fix issue #133 
+* Update EMTFXML ouptut format 
+* Add FC Metadata 
+
+0.3.0 (2023-09-29)
+---------------------
+
+* Fixing Bugs in https://github.com/kujaku11/mt_metadata/pull/138
+* adding a merge for TFs in https://github.com/kujaku11/mt_metadata/pull/136
+* Fix write EDI bugs in https://github.com/kujaku11/mt_metadata/pull/149
+* Use loguru instead of builtin logging in https://github.com/kujaku11/mt_metadata/pull/153
+* Loguru in https://github.com/kujaku11/mt_metadata/pull/154
+* Try to fix bug with filter assignment in https://github.com/kujaku11/mt_metadata/pull/155
+* Empower edi in https://github.com/kujaku11/mt_metadata/pull/158
+* TF survey metadata in https://github.com/kujaku11/mt_metadata/pull/159
+* added logic for if channel location values are None in https://github.com/kujaku11/mt_metadata/pull/160
+* Changes to support writing z-files with channel_nomenclature in https://github.com/kujaku11/mt_metadata/pull/161
+* Minor changes to support zfiles tests in https://github.com/kujaku11/mt_metadata/pull/163
+* Test aurora issue 295 in https://github.com/kujaku11/mt_metadata/pull/165
+* Fcs in https://github.com/kujaku11/mt_metadata/pull/142
+* Fcs in https://github.com/kujaku11/mt_metadata/pull/166
+* Update environment.yml in https://github.com/kujaku11/mt_metadata/pull/167
+* updating documentation in https://github.com/kujaku11/mt_metadata/pull/168
+
+0.3.1 (2023-10-15)
+-----------------------
+
+* Minor bug fixes
+
+0.3.2 (2023-11-08)
+-----------------------
+
+* remove restriction on Pandas < 2
+* minor bug fixes
+
+0.3.3 (2023-11-08)
+-----------------------
+
+* update pandas.append to concat
+
+0.3.4 ()
+-----------------------
+
+* Update HISTORY.rst by @kujaku11 in https://github.com/kujaku11/mt_metadata/pull/179
+* Remove filter direction attributes by @kkappler in https://github.com/kujaku11/mt_metadata/pull/181
+* Fix issue 173 by @kkappler in https://github.com/kujaku11/mt_metadata/pull/182
+* Patch 173 by @kkappler in https://github.com/kujaku11/mt_metadata/pull/183
+* Add some common helper functions by @kkappler in https://github.com/kujaku11/mt_metadata/pull/185
+* Bug fix in FC layer by @kkappler in https://github.com/kujaku11/mt_metadata/pull/186
+* Fix mth5 issue 187 by @kkappler in https://github.com/kujaku11/mt_metadata/pull/187
+* bug fixes by @kujaku11 in https://github.com/kujaku11/mt_metadata/pull/180
+* updating how a TF is initiated, initialize xarray is expensive by @kujaku11 in https://github.com/kujaku11/mt_metadata/pull/188
+* Change default value of `get_elevation` to False by @kujaku11 in https://github.com/kujaku11/mt_metadata/pull/191
+* Updating git clone address in the readme by @xandrd in https://github.com/kujaku11/mt_metadata/pull/189
+* Fix how Z-files read/write by @kujaku11 in https://github.com/kujaku11/mt_metadata/pull/192
+* Adjust how TF._initialize_transfer_function is setup by @kujaku11 in https://github.com/kujaku11/mt_metadata/pull/193
+* Add Ability to store processing configuration in TF by @kujaku11 in https://github.com/kujaku11/mt_metadata/pull/196
+* Bump version: 0.3.3 → 0.3.4 by @kujaku11 in https://github.com/kujaku11/mt_metadata/pull/198
+
+
+0.3.5 ()
+---------------------
+
+* Patches by @kujaku11 in https://github.com/kujaku11/mt_metadata/pull/200
+* Fix issue #202 by @kujaku11 in https://github.com/kujaku11/mt_metadata/pull/203
+* Patches by @kkappler in https://github.com/kujaku11/mt_metadata/pull/205
+* Bump version: 0.3.4 → 0.3.5 by @kujaku11 in https://github.com/kujaku11/mt_metadata/pull/206
+
+0.3.6 ()
+---------------------
+
+* add method for accessing mag channel names by @kkappler in https://github.com/kujaku11/mt_metadata/pull/210
+* Patches by @kujaku11 in https://github.com/kujaku11/mt_metadata/pull/208
+* Fix mth5 issue 207 by @kkappler in https://github.com/kujaku11/mt_metadata/pull/209
+* Minor changes  by @kkappler in https://github.com/kujaku11/mt_metadata/pull/211
+* Patches by @kujaku11 in https://github.com/kujaku11/mt_metadata/pull/212
+
+0.3.7 (2024-08-16)
+---------------------
+
+* Minor fixes numpy 2.0 by @kkappler in https://github.com/kujaku11/mt_metadata/pull/213
+* Fix issue 216 by @kkappler in https://github.com/kujaku11/mt_metadata/pull/218
+* Patches  by @kujaku11 in https://github.com/kujaku11/mt_metadata/pull/219
+* add u0 and r0 as regression parameters by @kkappler in https://github.com/kujaku11/mt_metadata/pull/220
+* Updating EMTF XML and StationXML writers by @kujaku11 in https://github.com/kujaku11/mt_metadata/pull/217
+* 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 
+
+1.0.0 (2026-01-19)
+----------------------
+
+* The underlying code has been refactored using Pydantic to improve performance and maintainability.
+* The metadata structure has been updated to better align with the latest standards and practices in geophysical data management.
+* The documentation has been improved to provide clearer guidance on usage and examples.
+* Tests have been update to `pytest`
+* `filtered` has been update to use a list of filters `AppliedFilter` objects and can include stage.
+* `Comments` is now an object with attributes including `value`, `author`, and `date`.
+* Moved many common class objects to folder called `common` to reduce redundancy.
+* In `timeseries.Run` use `add_channel` to add a channel if you `append`, `extend`, or `insert` a channel, then you must run `Run._update_channel` to update the metata.
+* `MetadataBase` no longer overrides `__deepcopy__` uses `model_copy(deep=True)` under the hood.
+* Cannot use len() on `Run`, `Station`, `Survey` objects, use `Run.n_channels`, `Station.n_runs`, `Survey.n_stations` instead.
+* Cannot use `__add__` in `BaseModel` objects, bad things happen, use Object method `merge(other)` instead.  
+* There are now a few `Location` objects including `BasicLocation`, `Location`, and `StationLocation`
+* moved `def get_base_obspy_mapping` to `timeseries.filters.helper_functions`
+* Units have been updated to be more compliant with SI standards.  All unit names must be singular for example volts must be `volt`. Unit validation returns the long name in lowercase. "mV/km" will be returned as "millivolt per kilometer".  There is also a `Unit` object in `mt_metadata.utils.units` that is a Pydantic Basemodel that can be used to access other representations of a unit, like symbol and plot label.
+* Filters type can only be a set value for the filter.  For example for an `FIRFilter` the type must be `FIR`.  The filter type is now a property of the filter object.  The filter type is not a property of the filter class.  This allows for more flexibility in the future.
+* Added ability to initiate a metadata object with a dictionary as in `Person(**kwargs)`.
+* Added `AuthorPerson` object to `mt_metadata.common` which is more in the style of the MT metadata.  You can still instantiate with `AuthorPerson(name="John Doe")` which will populate the `author` field.  However, you cannot get `name`, similarly with `Person(author="jon do")`.  
+* Changed `Filtered` to `Filters` which is a list of `AppliedFilter` objects.  The `AppliedFilter` object has attributes including `applied`, `comments`, `name`, and `stage`.  The `comments` attribute is an object with attributes including `value`, `author`, and `date`.  This allows for more flexibility in the future and better compliance with standards. It is backwards compatible with the old `Filtered` object, so you can still use it in the same way as before, but only using the `from_dict` method.
+* Added `MTime` object to `mt_metadata.common.mttime` which is a Pydantic Basemodel that can be used to access other representations of time, like ISO format, datetime, and pandas Timestamp.
+* Updated `get_now_utc` to return an `MTime` object.
+* Moved `listdict` to `mt_metadata.common.listdict` and added a `pop` method to it.
+* Moved `units` to `mt_metadata.common.units` and added a `Unit` object that is a Pydantic Basemodel that can be used to access other representations of a unit, like symbol and plot label.
+* In `features.CoherenceBaseModel` changed `station_1` and `station_2` to `station_1` and `station_2` to be more consistent with other objects.  The old attributes are still available for backwards compatibility, but will be deprecated in the future. Similar with channel, changed `ch1` and `ch2` to `channel_1` and `channel_2`.
+* Fix deprecation warnings by @kujaku11 in https://github.com/kujaku11/mt_metadata/pull/265
+* Revert "Fix deprecation warnings" by @kujaku11 in https://github.com/kujaku11/mt_metadata/pull/267
+* Fix deprecation warnings by @kujaku11 in https://github.com/kujaku11/mt_metadata/pull/266
+* Old pydantic 3 by @kujaku11 in https://github.com/kujaku11/mt_metadata/pull/268
+* Update how z-files are read in  by @kujaku11 in https://github.com/kujaku11/mt_metadata/pull/269
+* Update validation using Pydantic by @kujaku11 in https://github.com/kujaku11/mt_metadata/pull/255
+* Rebase using Pydantic by @kujaku11 in https://github.com/kujaku11/mt_metadata/pull/270
+
+
+**Full Changelog**: https://github.com/kujaku11/mt_metadata/compare/v0.4.0...v1.0.0

mt_metadata-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 JP
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mt_metadata-1.0.0/MANIFEST.in

@@ -0,0 +1,29 @@
+include AUTHORS.rst
+include CONTRIBUTING.rst
+include HISTORY.rst
+include LICENSE
+include README.rst
+
+recursive-include tests *
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+
+recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif
+recursive-include mt_metadata/utils *.yaml
+recursive-include mt_metadata/timeseries/filters/standards *.json
+recursive-include mt_metadata/timeseries/standards *.json
+recursive-include mt_metadata/transfer_functions/tf/standards *.json
+recursive-include mt_metadata/transfer_functions/io/emtfxml/metadata/standards *.json
+recursive-include mt_metadata/transfer_functions/io/edi/metadata/standards *.json
+recursive-include mt_metadata/transfer_functions/io/zfiles/metadata/standards *.json
+recursive-include mt_metadata/transfer_functions/io/jfiles/metadata/standards *.json
+recursive-include mt_metadata/transfer_functions/io/zonge/metadata/standards *.json
+recursive-include mt_metadata/transfer_functions/processing/standards *.json
+recursive-include mt_metadata/transfer_functions/processing/aurora/standards *.json
+recursive-include mt_metadata/transfer_functions/processing/fourier_coefficients/standards *.json
+recursive-include mt_metadata/features/standards *.json
+recursive-include mt_metadata/features/test_helpers *.json
+recursive-include mt_metadata/features/weights/standards *.json
+recursive-include mt_metadata/data/mt_xml *.xml
+recursive-include mt_metadata/data/stationxml *.xml
+recursive-include mt_metadata/data/transfer_functions *.edi *.xml *.j *.zmm *.zss *.avg