From 7c90ad968ab0467bf545053215eb5e93ef0e0bdc Mon Sep 17 00:00:00 2001 From: cyschneck <22159116+cyschneck@users.noreply.github.com> Date: Thu, 18 Jul 2024 12:30:05 -0600 Subject: [PATCH] orchid id citation --- CITATION.cff | 13 +++++++++---- README.md | 6 +++--- 2 files changed, 12 insertions(+), 7 deletions(-) diff --git a/CITATION.cff b/CITATION.cff index cd0bf7d..29b671e 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -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" diff --git a/README.md b/README.md index 101a8f7..40d4261 100644 --- a/README.md +++ b/README.md @@ -411,8 +411,8 @@ 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"]` @@ -420,7 +420,7 @@ calculateIncrementalSinuosity( ```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}`