Metadata-Version: 2.1
Name: earthscopestraintools
Version: 0.1.39
Summary: A collection of utilities for working with EarthScope strainmeter data
Author-email: Mike Gottlieb <mike.gottlieb@eartscope.org>
License: Copyright (c) 2023
        
        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.
Project-URL: Homepage, https://gitlab.com/earthscope/gds/strain/earthscopestraintools
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: scipy >=1.10.1
Requires-Dist: numpy >=1.24.1
Requires-Dist: pandas >=2.1.0
Requires-Dist: requests >=2.28.2
Requires-Dist: geopy >=2.3.0
Provides-Extra: mseed
Requires-Dist: obspy >=1.4.0 ; extra == 'mseed'
Provides-Extra: plotting
Requires-Dist: ipympl >=0.9.3 ; extra == 'plotting'
Provides-Extra: tiledb
Requires-Dist: tiledb ==0.23.0 ; extra == 'tiledb'
Requires-Dist: pyarrow ==13.0.0 ; extra == 'tiledb'

Welcome to earthscopestraintools, an open source python package for working with strainmeter data.  This project is available as a beta release, but is still actively under development and should not be considered stable at this time. 

M. Gottlieb and C. Hanagan 6-1-2024


Documentation can be found at https://earthscopestraintools.readthedocs.io/en/latest/ 

Pypi releases available from
https://pypi.org/project/earthscopestraintools/

earthscopestraintools can be installed with 
    
> pip install earthscopestraintools

Or with optional dependencies:
```
pip install 'earthscopestraintools[mseed]'
pip install 'earthscopestraintools[tiledb]'
pip install 'earthscopestraintools[plotting]'
pip install 'earthscopestraintools[mseed,tiledb,plotting]'
```

It is currently recommendeed to install the mseed optional dependencies, which includes obspy and some tools for loading data from the EarthScope miniseed archive.  The tiledb functionality, as of version 0.1.38, is not yet well implemented. Also please note that the tiledb dependencies do not work with python 3.12, but should work with python 3.9-3.11.  Plotting dependencies include ipympl for enabling notebook interaction, including plotting strain videos.

Some functionality (tidal analysis and corrections) depends on BAYTAP-08 and SPOTL, two legacy FORTRAN programs, which have been containerized for use by this library.  In order to run these processing methods, you must have Docker installed and running on your computer.  When required, the library will then fetch the required images and be able to run these processing steps.
