Skip to content
This repository has been archived by the owner on Jan 6, 2022. It is now read-only.

Commit

Permalink
Update README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
rmcd-mscb authored May 27, 2020
1 parent 62e175c commit 8a8ffb3
Showing 1 changed file with 37 additions and 35 deletions.
72 changes: 37 additions & 35 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,43 +43,45 @@ Use
-------
From your conda environment created above:

```
(gmetl) B:\gitbmi\gridmetetl>gridmetetl -h

usage: gridmet_etl [-h] -t extraction type [-p YYYY-MM-DD) (YYYY-MM-DD]
[-d numdays] [-f output_file_prefix] -i input_path -o
output_path -w weight_file
[-v [GridMet_Variables [GridMet_Variables ...]]]

map gridded climate data to polygon using zonal area weighted mean

optional arguments:
-h, --help show this help message and exit
-t extraction type, --extract_type extraction type
extract method: (days) or (date)
-p (YYYY-MM-DD) (YYYY-MM-DD), --period (YYYY-MM-DD) (YYYY-MM-DD)
option: start date and end date of retrieval (YYYY-MM-
DD)
-d numdays, --days numdays
option: number of days to retrieve; if specified take
precedence over -s & -e option
-f output_file_prefix, --file_prefix output_file_prefix
option: prefix for output files
-i input_path, --inpath input_path
input_path (location of HRU shapefiles)
-o output_path, --outpath output_path
Output path (location of netcdf output files by
shapefile output)
-w weight_file, --weightsfile weight_file
path/weight.csv - path/name of weight file
-v [GridMet_Variables [GridMet_Variables ...]], --variables [GridMet_Variables [GridMet_Variables ...]]
over-ride default vars
```
.. code-block:: bash
(gmetl) B:\gitbmi\gridmetetl>gridmetetl -h
usage: gridmet_etl [-h] -t extraction type [-p YYYY-MM-DD) (YYYY-MM-DD]
[-d numdays] [-f output_file_prefix] -i input_path -o
output_path -w weight_file
[-v [GridMet_Variables [GridMet_Variables ...]]]
map gridded climate data to polygon using zonal area weighted mean
optional arguments:
-h, --help show this help message and exit
-t extraction type, --extract_type extraction type
extract method: (days) or (date)
-p (YYYY-MM-DD) (YYYY-MM-DD), --period (YYYY-MM-DD) (YYYY-MM-DD)
option: start date and end date of retrieval (YYYY-MM-
DD)
-d numdays, --days numdays
option: number of days to retrieve; if specified take
precedence over -s & -e option
-f output_file_prefix, --file_prefix output_file_prefix
option: prefix for output files
-i input_path, --inpath input_path
input_path (location of HRU shapefiles)
-o output_path, --outpath output_path
Output path (location of netcdf output files by
shapefile output)
-w weight_file, --weightsfile weight_file
path/weight.csv - path/name of weight file
-v [GridMet_Variables [GridMet_Variables ...]], --variables [GridMet_Variables [GridMet_Variables ...]]
over-ride default vars
### Do an ETL:
```
gridmetetl -t date -p 2018-09-01 2018-09-02 -i ../../GitRepos/onhm-fetcher-parser/Data -o ../../GitRepos/onhm-fetcher-parser/Output -w ../../onhm-fetcher-parser/Data/weights.csv
```
.. code-block:: bash
gridmetetl -t date -p 2018-09-01 2018-09-02 -i ../../GitRepos/onhm-fetcher-parser/Data -o ../../GitRepos/onhm-fetcher-parser/Output -w ../../onhm-fetcher-parser/Data/weights.csv
### Additional examples:
https://github.com/nhm-usgs/gridmetetl/blob/master/Examples/Example_code_usage.ipynb
Expand Down

0 comments on commit 8a8ffb3

Please sign in to comment.