Skip to content

Commit af3e58c

Browse files
committed
docs: update README
1 parent 1010981 commit af3e58c

File tree

2 files changed

+30
-12
lines changed

2 files changed

+30
-12
lines changed

README.Rmd

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,20 @@ Usage:
2929
Examples:
3030
hfsubset -l divides,nexus \
3131
-o ./divides_nexus.gpkg \
32-
-r "pre-release" \
33-
-t hl \
32+
-r "v20" \
33+
-t hl_uri \
3434
"Gages-06752260"
3535
36-
hfsubset -o ./poudre.gpkg -t hl "Gages-06752260"
36+
hfsubset -o ./poudre.gpkg -t hl_uri "Gages-06752260"
37+
38+
# Using network-linked data index identifiers
39+
hfsubset -o ./poudre.gpkg -t nldi_feature "nwis:USGS-08279500"
40+
41+
# Specifying layers and hydrofabric version
42+
hfsubset -l divides,nexus -o ./divides_nexus.gpkg -r "v20" -t hl_uri "Gages-06752260"
43+
44+
# Finding data around a POI
45+
hfsubset -l flowpaths,reference_flowpaths -o ./sacramento_flowpaths.gpkg -t xy -121.494400,38.581573
3746
3847
Options:
3948
-l string
@@ -47,9 +56,9 @@ Options:
4756
-quiet
4857
Disable progress bar
4958
-r string
50-
Hydrofabric version (default "pre-release")
59+
Hydrofabric version (default "v20")
5160
-t string
52-
One of: "id", "hl_uri", "comid", "xy", or "nldi" (default "hf")
61+
One of: "id", "hl_uri", "comid", "xy", or "nldi_feature" (default "id")
5362
```
5463

5564
## NextGen Needs GeoJSON
@@ -64,7 +73,7 @@ Here is a full-stop example of extracting a subset for a hydrolocation, using th
6473
mkdir poudre
6574
cd poudre
6675
67-
hfsubset -l core -o ./poudre-subset.gpkg -r "pre-release" -t hl_uri "Gages-06752260"
76+
hfsubset -l core -o ./poudre-subset.gpkg -r "v20" -t hl_uri "Gages-06752260"
6877
6978
ogr2ogr -f GeoJSON catchments.geojson poudre-subset.gpkg divides
7079
ogr2ogr -f GeoJSON nexus.geojson poudre-subset.gpkg nexus

README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,20 @@ Usage:
2121
Examples:
2222
hfsubset -l divides,nexus \
2323
-o ./divides_nexus.gpkg \
24-
-r "pre-release" \
25-
-t hl \
24+
-r "v20" \
25+
-t hl_uri \
2626
"Gages-06752260"
2727

28-
hfsubset -o ./poudre.gpkg -t hl "Gages-06752260"
28+
hfsubset -o ./poudre.gpkg -t hl_uri "Gages-06752260"
29+
30+
# Using network-linked data index identifiers
31+
hfsubset -o ./poudre.gpkg -t nldi_feature "nwis:USGS-08279500"
32+
33+
# Specifying layers and hydrofabric version
34+
hfsubset -l divides,nexus -o ./divides_nexus.gpkg -r "v20" -t hl_uri "Gages-06752260"
35+
36+
# Finding data around a POI
37+
hfsubset -l flowpaths,reference_flowpaths -o ./sacramento_flowpaths.gpkg -t xy -121.494400,38.581573
2938

3039
Options:
3140
-l string
@@ -39,9 +48,9 @@ Options:
3948
-quiet
4049
Disable progress bar
4150
-r string
42-
Hydrofabric version (default "pre-release")
51+
Hydrofabric version (default "v20")
4352
-t string
44-
One of: "id", "hl_uri", "comid", "xy", or "nldi" (default "hf")
53+
One of: "id", "hl_uri", "comid", "xy", or "nldi_feature" (default "id")
4554
```
4655

4756
## NextGen Needs GeoJSON
@@ -59,7 +68,7 @@ using the CLI, and generating the needed files for NextGen
5968
mkdir poudre
6069
cd poudre
6170

62-
hfsubset -l core -o ./poudre-subset.gpkg -r "pre-release" -t hl_uri "Gages-06752260"
71+
hfsubset -l core -o ./poudre-subset.gpkg -r "v20" -t hl_uri "Gages-06752260"
6372

6473
ogr2ogr -f GeoJSON catchments.geojson poudre-subset.gpkg divides
6574
ogr2ogr -f GeoJSON nexus.geojson poudre-subset.gpkg nexus

0 commit comments

Comments
 (0)