ngf-aws-open-data-client

Read miniSEED waveforms directly from S3, mirroring obspy.clients.fdsn.Client.get_waveforms.

Defaults to EarthScope's public AWS Open Data bucket (s3://earthscope-geophysical-data/miniseed, us-east-2, unsigned/anonymous access), but every aspect of the connection (bucket path, region, credentials, endpoint) and the key layout is configurable, so the same client works against any S3 bucket that stores day-volume miniSEED files.

Installing

pip install -e .          # editable install for development
pip install -e ".[test]"  # + pytest, for running tests/

Usage

from obspy import UTCDateTime
from ngf_aws_open_data_client import NGFS3Client

client = NGFS3Client()

st = client.get_waveforms(
    network="IU", station="ANMO", location="00", channel="BHZ",
    starttime=UTCDateTime("2023-01-01T00:00:00"),
    endtime=UTCDateTime("2023-01-01T00:10:00"),
)
st.write("waveformData.mseed", format="MSEED")

Against a private bucket with a different key layout:

client = NGFS3Client(
    bucket_path="s3://my-miniseed",
    anon=False,
    profile_name="my_profile",
    key_template="{station}/{year}/{doy}/{station}.{network}.{year}.{doy}",
)

Running tests

pytest tests/

Building and publishing to PyPI

python -m pip install build twine
python -m build                                        # writes dist/*.tar.gz and dist/*.whl
python -m twine upload --repository testpypi dist/*    # try it on TestPyPI first
python -m twine upload dist/*                           # then the real PyPI

Bump the version in pyproject.toml (and __version__ in src/ngf_aws_open_data_client/__init__.py) before each release.