pymseed 0.0.1__tar.gz

pymseed-0.0.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

pymseed-0.0.1/MANIFEST.in

@@ -0,0 +1,19 @@
+# Include the cffi module and libmseed source code
+recursive-include cffi_module *.py *.c *.h *.md *.txt *.in *.pc.in *.def *.map
+recursive-include cffi_module/libmseed *
+recursive-exclude cffi_module/libmseed *.o *.a *.lib *.so *.dll *.pyd
+
+# Include examples
+recursive-include examples *.py
+
+# Include test data
+recursive-include tests/data *
+
+# Include development files
+include development.txt
+
+# Standard files already included by default
+include LICENSE
+include README.md
+include pyproject.toml
+include setup.py

pymseed-0.0.1/PKG-INFO

@@ -0,0 +1,194 @@
+Metadata-Version: 2.4
+Name: pymseed
+Version: 0.0.1
+Summary: A Python package for reading and writing miniSEED formatted data
+Author-email: EarthScope Data Services <software@earthscope.org>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/EarthScope/pymseed
+Project-URL: Repository, https://github.com/EarthScope/pymseed
+Project-URL: Issues, https://github.com/EarthScope/pymseed/issues
+Keywords: seismology,miniseed,mseed,data,waveform,seismic
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: POSIX :: Other
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cffi>=1.15.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Requires-Dist: pre-commit>=3.0.0; extra == "dev"
+Provides-Extra: numpy
+Requires-Dist: numpy>=1.21.0; extra == "numpy"
+Provides-Extra: docs
+Requires-Dist: sphinx>=5.0.0; extra == "docs"
+Requires-Dist: sphinx-rtd-theme>=1.0.0; extra == "docs"
+Requires-Dist: sphinxcontrib-napoleon>=0.7; extra == "docs"
+Provides-Extra: test
+Requires-Dist: pytest>=7.0.0; extra == "test"
+Requires-Dist: pytest-cov>=4.0.0; extra == "test"
+Requires-Dist: numpy>=1.21.0; extra == "test"
+Provides-Extra: release
+Requires-Dist: build>=0.10.0; extra == "release"
+Requires-Dist: twine>=4.0.0; extra == "release"
+Provides-Extra: all
+Requires-Dist: pymseed[dev,docs,numpy,test]; extra == "all"
+Dynamic: license-file
+
+# pymseed - a Python package to read and write miniSEED formatted data
+
+The pymseed package allows for reading and writing of miniSEED
+time series data.  Both [miniSEED version 2](https://fdsn.org/pdf/SEEDManual_V2.4.pdf)
+(defined in the SEED standard) and [miniSEED version 3](https://docs.fdsn.org/projects/miniseed3)
+are supported.
+
+The package is based on the C-language [libmseed](https://earthscope.github.io/libmseed)
+for most of the data format and manipulation work.
+
+## Installation
+
+The [releases](https://pypi.org/project/pymseed/) should be installed
+directly from PyPI with, for example, `pip install pymseed`.
+
+The package is built using [CFFI](https://cffi.readthedocs.io/) and supports
+multiple Python implementations including CPython and PyPy for broad usability.
+
+If using numpy features use optional dependency "numpy" or install it independently
+e.g. `pip install pymseed[numpy]`.
+
+For package develop use optional dependency "dev" for needed dependencies
+e.g. `pip install pymseed[dev]`.
+
+## Example usage
+
+Working programs for a variety of use cases ca be found in the
+[examples](https://github.com/EarthScope/pymseed/tree/main/examples) directory of the repository.
+
+Read a file and print details from each record:
+```Python
+from pymseed import MS3RecordReader,TimeFormat
+
+input_file = 'testdata-3channel-signal.mseed3'
+
+with MS3RecordReader(input_file) as msreader:
+    for msr in msreader:
+        # Print values directly
+        print(f'   SourceID: {msr.sourceid}, record length {msr.reclen}')
+        print(f' Start Time: {msr.starttime_str(timeformat=TimeFormat.ISOMONTHDAY_SPACE_Z)}')
+        print(f'    Samples: {msr.samplecnt}')
+
+        # Alternatively, use the library print function
+        msr.print()
+```
+
+Read a file into a trace list and print the list:
+```Python
+from pymseed import MS3TraceList
+
+input_file = 'testdata-3channel-signal.mseed3'
+
+mstl = MS3TraceList(input_file)
+
+# Print the trace list using the library print function
+mstl.print(details=1, gaps=True)
+
+# Alternatively, traverse the data structures and print each trace ID and segment
+for traceid in mstl.traceids():
+    print(traceid)
+
+    for segment in traceid.segments():
+        print('  ', segment)
+```
+
+Writing miniSEED requires specifying a "record handler" function that is
+a callback to consume, and do whatever you want, with generated records.
+
+Simple example of writing multiple channels of data:
+```Python
+import math
+from pymseed import MS3TraceList, timestr2nstime
+
+# Generate synthetic sinusoid data, starting at 0, 45, and 90 degrees
+data0 = list(map(lambda x: int(math.sin(math.radians(x)) * 500), range(0, 500)))
+data1 = list(map(lambda x: int(math.sin(math.radians(x)) * 500), range(45, 500 + 45)))
+data2 = list(map(lambda x: int(math.sin(math.radians(x)) * 500), range(90, 500 + 90)))
+
+mstl = MS3TraceList()
+
+sample_rate = 40.0
+start_time = timestr2nstime("2024-01-01T15:13:55.123456789Z")
+format_version = 2
+record_length = 512
+
+# Add synthetic data to the trace list
+mstl.add_data(sourceid="FDSN:XX_TEST__B_S_1",
+              data_samples=data0, sample_type='i',
+              sample_rate=sample_rate, start_time=start_time)
+
+mstl.add_data(sourceid="FDSN:XX_TEST__B_S_2",
+              data_samples=data1, sample_type='i',
+              sample_rate=sample_rate, start_time=start_time)
+
+mstl.add_data(sourceid="FDSN:XX_TEST__B_S_3",
+              data_samples=data2, sample_type='i',
+              sample_rate=sample_rate, start_time=start_time)
+
+# Record handler called for each generated record
+def record_handler(record, handler_data):
+    handler_data['fh'].write(record)
+
+output_file = 'output.mseed'
+
+with open(output_file, 'wb') as file_handle:
+  # Generate miniSEED records
+  mstl.pack(record_handler,
+            {'fh':file_handle},
+            format_version=format_version,
+            record_length=record_length,
+            flush_data=True)
+```
+
+## Package design rationale
+
+The package functionality and exposed API are designed to support the most
+common use cases of reading and writing miniSEED data using `libmseed`.
+Extensions of data handling beyond the functionality of the library are
+out-of-scope for this package.  Furthermore, the naming of functions, classes,
+arguments, etc. often follows the naming used in the library in order to
+reference their fundamentals at the C level if needed; even though this leaves
+some names distinctly non-Pythonic.
+
+In a nutshell, the goal of this package is to provide just enough of a Python
+layer to `libmseed` to handle the most common cases of miniSEED data without
+needing to know any of the C-level details.
+
+## License
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+Copyright (C) 2025 EarthScope Data Services

pymseed-0.0.1/README.md

@@ -0,0 +1,142 @@
+# pymseed - a Python package to read and write miniSEED formatted data
+
+The pymseed package allows for reading and writing of miniSEED
+time series data.  Both [miniSEED version 2](https://fdsn.org/pdf/SEEDManual_V2.4.pdf)
+(defined in the SEED standard) and [miniSEED version 3](https://docs.fdsn.org/projects/miniseed3)
+are supported.
+
+The package is based on the C-language [libmseed](https://earthscope.github.io/libmseed)
+for most of the data format and manipulation work.
+
+## Installation
+
+The [releases](https://pypi.org/project/pymseed/) should be installed
+directly from PyPI with, for example, `pip install pymseed`.
+
+The package is built using [CFFI](https://cffi.readthedocs.io/) and supports
+multiple Python implementations including CPython and PyPy for broad usability.
+
+If using numpy features use optional dependency "numpy" or install it independently
+e.g. `pip install pymseed[numpy]`.
+
+For package develop use optional dependency "dev" for needed dependencies
+e.g. `pip install pymseed[dev]`.
+
+## Example usage
+
+Working programs for a variety of use cases ca be found in the
+[examples](https://github.com/EarthScope/pymseed/tree/main/examples) directory of the repository.
+
+Read a file and print details from each record:
+```Python
+from pymseed import MS3RecordReader,TimeFormat
+
+input_file = 'testdata-3channel-signal.mseed3'
+
+with MS3RecordReader(input_file) as msreader:
+    for msr in msreader:
+        # Print values directly
+        print(f'   SourceID: {msr.sourceid}, record length {msr.reclen}')
+        print(f' Start Time: {msr.starttime_str(timeformat=TimeFormat.ISOMONTHDAY_SPACE_Z)}')
+        print(f'    Samples: {msr.samplecnt}')
+
+        # Alternatively, use the library print function
+        msr.print()
+```
+
+Read a file into a trace list and print the list:
+```Python
+from pymseed import MS3TraceList
+
+input_file = 'testdata-3channel-signal.mseed3'
+
+mstl = MS3TraceList(input_file)
+
+# Print the trace list using the library print function
+mstl.print(details=1, gaps=True)
+
+# Alternatively, traverse the data structures and print each trace ID and segment
+for traceid in mstl.traceids():
+    print(traceid)
+
+    for segment in traceid.segments():
+        print('  ', segment)
+```
+
+Writing miniSEED requires specifying a "record handler" function that is
+a callback to consume, and do whatever you want, with generated records.
+
+Simple example of writing multiple channels of data:
+```Python
+import math
+from pymseed import MS3TraceList, timestr2nstime
+
+# Generate synthetic sinusoid data, starting at 0, 45, and 90 degrees
+data0 = list(map(lambda x: int(math.sin(math.radians(x)) * 500), range(0, 500)))
+data1 = list(map(lambda x: int(math.sin(math.radians(x)) * 500), range(45, 500 + 45)))
+data2 = list(map(lambda x: int(math.sin(math.radians(x)) * 500), range(90, 500 + 90)))
+
+mstl = MS3TraceList()
+
+sample_rate = 40.0
+start_time = timestr2nstime("2024-01-01T15:13:55.123456789Z")
+format_version = 2
+record_length = 512
+
+# Add synthetic data to the trace list
+mstl.add_data(sourceid="FDSN:XX_TEST__B_S_1",
+              data_samples=data0, sample_type='i',
+              sample_rate=sample_rate, start_time=start_time)
+
+mstl.add_data(sourceid="FDSN:XX_TEST__B_S_2",
+              data_samples=data1, sample_type='i',
+              sample_rate=sample_rate, start_time=start_time)
+
+mstl.add_data(sourceid="FDSN:XX_TEST__B_S_3",
+              data_samples=data2, sample_type='i',
+              sample_rate=sample_rate, start_time=start_time)
+
+# Record handler called for each generated record
+def record_handler(record, handler_data):
+    handler_data['fh'].write(record)
+
+output_file = 'output.mseed'
+
+with open(output_file, 'wb') as file_handle:
+  # Generate miniSEED records
+  mstl.pack(record_handler,
+            {'fh':file_handle},
+            format_version=format_version,
+            record_length=record_length,
+            flush_data=True)
+```
+
+## Package design rationale
+
+The package functionality and exposed API are designed to support the most
+common use cases of reading and writing miniSEED data using `libmseed`.
+Extensions of data handling beyond the functionality of the library are
+out-of-scope for this package.  Furthermore, the naming of functions, classes,
+arguments, etc. often follows the naming used in the library in order to
+reference their fundamentals at the C level if needed; even though this leaves
+some names distinctly non-Pythonic.
+
+In a nutshell, the goal of this package is to provide just enough of a Python
+layer to `libmseed` to handle the most common cases of miniSEED data without
+needing to know any of the C-level details.
+
+## License
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+Copyright (C) 2025 EarthScope Data Services

pymseed-0.0.1/cffi_module/README_libmseed.md

@@ -0,0 +1,32 @@
+# libmseed source management in pymseed
+
+This directory contains the CFFI module for libmseed used by pymseed.
+This module is private and used through Python API of pymseed.
+
+## Updating libmseed
+
+The libmseed source code is in the `libmseed` subdirectory and is simply the
+sources from a release available from:
+https://github.com/EarthScope/libmseed/releases
+
+The CFFI package requires definitions of the C functions, structures, constants,
+etc. to be used from the library.  This is in essence the public API expressed
+in `libmseed.h`.  The rub is that the CFFI definition parser cannot understand
+complex C headers and so cannot use the library headers directly.   The solution
+is to maintain a simplified set of definitions from `libmseed.h` specifically
+for CFFI in the `cffi_defs.py` file.
+
+To update to a new release:
+1. copy the new sources to the `libmseed` directory
+2. add any new files
+3. review and update `cffi_defs.py` definitions to make sure it matches any changes in `libmseed.h`
+4. commit all changes
+
+p.s. A CFFI-usable header definitions is manually maintained due to lack of
+robust solutions to parse C headers into the simplified form.
+
+## Dynamic versioning
+
+During the CFFI module build process (when building wheels) the version of
+libmseed is extracted and stored in the pymseed package to ensure they are in
+sync.