ecastillot commited on
Commit
c7b0dc5
·
verified ·
1 Parent(s): fbec774

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +15 -3
README.md CHANGED
@@ -277,13 +277,25 @@ configs:
277
  # <span style="background:#E87500; color:white; padding:2px 6px; border-radius:6px;">UTD</span>Quake
278
  University of Texas at Dallas Earthquake Dataset
279
 
280
- # Dataset
281
-
282
- ## Installation ([utdquake](https://pypi.org/project/utdquake))
283
  ```bash
284
  pip install utdquake==0.1
285
  ```
286
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
287
  ## Why this dataset matters?
288
 
289
  Curated datasets of earthquake **events and phase picks** are essential for modern seismology, especially in the AI era. While waveform datasets have advanced earthquake detection, multistation picks provide complementary information crucial for **phase association** and **earthquake location**.
 
277
  # <span style="background:#E87500; color:white; padding:2px 6px; border-radius:6px;">UTD</span>Quake
278
  University of Texas at Dallas Earthquake Dataset
279
 
280
+ # Installation ([utdquake](https://pypi.org/project/utdquake))
 
 
281
  ```bash
282
  pip install utdquake==0.1
283
  ```
284
 
285
+ # Documentation
286
+
287
+ Full documentation for UTDQuake is available here:
288
+
289
+ [![Read the Docs](https://img.shields.io/badge/Docs-Read%20the%20Docs-blue?style=for-the-badge&logo=read-the-docs)](https://utdquake.readthedocs.io/en/latest/index.html)
290
+
291
+ You will see:
292
+
293
+ - QuickStart guide to get you up and running
294
+ - Detailed API reference
295
+ - Tutorials and example workflows
296
+
297
+ # Dataset
298
+
299
  ## Why this dataset matters?
300
 
301
  Curated datasets of earthquake **events and phase picks** are essential for modern seismology, especially in the AI era. While waveform datasets have advanced earthquake detection, multistation picks provide complementary information crucial for **phase association** and **earthquake location**.