Update documentation

6 years ago · 0b372f6d79
parent fec0e858c6
commit 0b372f6d79
2 changed files with 6 additions and 13 deletions
--- a/README.md
+++ b/README.md
@ -26,11 +26,11 @@ https://github.com/mozilla/geckodriver/releases
 from waternsw_grabber import telemetered_bore_downloader, extract_records

 basin_name = 'Bega River Basin'
-download_dir = '.'
+download_dir = 'downloads'

 # Download bore records
-telemetered_bore_downloader(basin_name, download_dir)
+telemetered_bore_downloader(basin_name)

 # Extract zip archives
-extract_records(basin_name, download_dir)
+extract_records(basin_name)
 ```
--- a/doc/demo.py
+++ b/doc/demo.py
@ -1,17 +1,10 @@
 from waternsw_grabber import telemetered_bore_downloader, extract_records

+basin_name = 'Bega River Basin'
 download_dir = 'downloads'
-output_dir = 'csv'
-start_date = '1900-01-01'
-end_date = '2019-02-14'
-bore_ids = [
-    'GW039102.1.1',
-    'GW039114.1.1',
-    'GW039117.1.1',
-]

 # Download bore records
-telemetered_bore_downloader(bore_ids, start_date, end_date, download_dir)
+telemetered_bore_downloader(basin_name)

 # Extract zip archives
-extract_records(download_dir, output_dir, clean_up=False)
+extract_records(basin_name)