Metadata-Version: 2.4
Name: pygeodl
Version: 0.0.3
Summary: Download geoscience data with ease.
Author-email: Morgan Plain <morgan@placeholder.com>
Maintainer-email: Morgan Plain <morgan@placeholder.com>
License-Expression: MIT
Project-URL: Homepage, https://example.com
Project-URL: Documentation, https://readthedocs.org
Project-URL: Repository, https://github.com/mp-v2/pygeodl.git
Project-URL: Bug Tracker, https://github.com/mp-v2/pygeodl/issues
Project-URL: Changelog, https://github.com/mp-v2/pygeodl/blob/main/CHANGELOG.md
Keywords: earth-science,geodesy,downloader,wrapper,gnss,gps,geodesy,seismology,earthquake,unavco,bgs
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering :: GIS
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: pandas>=2.2.2
Requires-Dist: requests>=2.32.3
Requires-Dist: loguru>=0.7.3
Requires-Dist: beautifulsoup4>=4.14.3
Provides-Extra: test
Requires-Dist: pytest>=8.2.2; extra == "test"

# pygeodl

Download geoscience data with ease.

Currently suopports:
- UNAVCO: GNSS
- BGS: Seismic events

Feel free to request other data sources be added, via [GitHub issues](https://github.com/mp-v2/pygeodl/issues/new).

## Installation

You can install `pygeodl` using pip:

```bash
pip install pygeodl
```

If you want to install it directly from the repository, you can do:

```bash
pip install git+https://github.com/mp-v2/pygeodl.git
```

## Usage

Here is a simple example of how to use `pygeodl` to download GNSS data from the UNAVCO repository.

```python
import pygeodl.gnss as gnss

# Create a downloader instance for UNAVCO
downloader = gnss.unavco()

# Find stations in a bounding box
df_stations = downloader.find(
    minlatitude=43.0,
    maxlatitude=60.0,
    minlongitude=-122.0,
    maxlongitude=-120.0,
    starttime="2012-01-01",
    endtime="2025-01-01",
)

print(df_stations.head())

# Request data for a specific station and time period
df = downloader.request(station="P201", starttime="2020-01-01", endtime="2020-01-02")

# Print the first few rows of the dataframe
print(df.head())
```

This will output a pandas DataFrame with the requested GNSS data.

## Examples

Working example scripts can be found in the examples folder.
- examples/get_unavco_gnss.py
- examples/get_bgs_seismic.py
