Skip to content

Commit

Permalink
orchid id citation
Browse files Browse the repository at this point in the history
  • Loading branch information
cyschneck committed Jul 18, 2024
1 parent d18ea0e commit 7c90ad9
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 7 deletions.
13 changes: 9 additions & 4 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
cff-version: 1.2.0
title: "centerline-width: River analysis, centerline, and width extraction software"
version: 1.6.0
message: "Please acknowledge the use of this software in any publications by citing:"
authors:
- family-names: "Schneck, Schneck"
given-names: Una G, Cora Y"
title: "centerline-width: River centerline/width extraction software"
version: 1.6.0
- family-names: Schneck
given-names: Cora Y.
orchid: 'https://orcid.org/0009-0009-1415-5170'
- family-names: Schneck
given-names: Una G.
orchid: 'https://orcid.org/0000-0003-0048-5143'
repository-code:: "https://github.com/cyschneck/centerline-width"
url: "https://github.com/cyschneck/centerline-width"
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -411,16 +411,16 @@ The sinuosity of the river returns as a float `0.6852533956654481`
Return the incremental sinuosity of the river at evenly spaced increments
```
calculateIncrementalSinuosity(
incremental_points = 100,
save_to_csv = None)
incremental_points=100,
save_to_csv=None)
```
* **[REQUIRED]** incremental_points: grouping of centerline coordinates, defaults to 100 (must be less than the length of the evenly spaced centerline coordinates)
* [OPTIONAL] save_to_csv (string): CSV filename, requires a .csv extension with headers `["Centerline Latitude Start (Deg)", "Centerline Longitude Start (Deg)", "Centerline Latitude End (Deg)", "Centerline Longitude End (Deg)", "Sinuosity"]`

```python
import centerline_width
river_object = centerline_width.riverCenterline(csv_data="data/river_coords.csv")
river_object.river.calculateIncrementalSinuosity()
river_object.calculateIncrementalSinuosity()
```
Returns a dictionary with the start and end centerline coordinates and associated sinuosity `{((-92.87803465419134, 30.04494734395193), (-92.87718084516158, 30.03944640478984)): 0.8164574107802118, ((-92.87714797109666, 30.03944945940497), (-92.87020323809925, 30.039886265891074)): 0.9810773013508994}`

Expand Down

0 comments on commit 7c90ad9

Please sign in to comment.