Skip to content

Commit 333dcb1

Browse files
committed
add readme
1 parent 7dd130f commit 333dcb1

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# pygeodl
2+
3+
Download geoscience data with ease.
4+
5+
Currently suopports:
6+
- UNAVCO: GNSS
7+
8+
## Installation
9+
10+
You can install `pygeodl` using pip:
11+
12+
```bash
13+
pip install pygeodl
14+
```
15+
16+
If you want to install it directly from the repository, you can do:
17+
18+
```bash
19+
pip install git+https://github.com/mp-v2/pygeodl.git
20+
```
21+
22+
## Usage
23+
24+
Here is a simple example of how to use `pygeodl` to download GNSS data from the UNAVCO repository.
25+
26+
```python
27+
import pygeodl.gnss as gnss
28+
29+
# Create a downloader instance for UNAVCO
30+
downloader = gnss.unavco()
31+
32+
# Request data for a specific station and time period
33+
df = downloader.request(station="P201", start_date="2020-01-01", end_date="2020-01-02")
34+
35+
# Print the first few rows of the dataframe
36+
print(df.head())
37+
```
38+
39+
This will output a pandas DataFrame with the requested GNSS data.

0 commit comments

Comments
 (0)