Skip to content

Commit 26de087

Browse files
samland1116samlamont
samland1116
and
samlamont
authored
565 update signaturemetrics class to signatures (#566)
* updates src references to signature_metrics as signatures * update documentation references to signatures instead of signaturemetrics * update reference in example * increment dev version in __init__.py and .toml --------- Co-authored-by: samlamont <sam.lamont@gmail.com>
1 parent 961a7f0 commit 26de087

File tree

11 files changed

+47
-46
lines changed

11 files changed

+47
-46
lines changed

‎docs/sphinx/api/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ Classes for defining and customizing metrics and bootstrap models.
135135
:nosignatures:
136136

137137
DeterministicMetrics
138-
SignatureMetrics
138+
Signatures
139139
ProbabilisticMetrics
140140
Bootstrappers
141141

‎docs/sphinx/changelog/index.rst‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Changed
3333

3434

3535
0.4.12 - 2025-05-22
36-
------------------
36+
-------------------
3737

3838
Changed
3939
^^^^^^^
@@ -42,7 +42,7 @@ Changed
4242
- Removes the repartitioning by `self.partition_by` of the dataframe in the `BaseTable` class when writing to parquet
4343

4444
0.4.11 - 2025-05-19
45-
------------------
45+
-------------------
4646

4747
Changed
4848
^^^^^^^
@@ -54,7 +54,7 @@ Changed
5454
- Added the option to skip the dropDuplicates() method when writing dataframes in the BaseTable class.
5555

5656
0.4.10 - 2025-04-14
57-
------------------
57+
-------------------
5858

5959
Added
6060
^^^^^
@@ -165,7 +165,7 @@ Changed
165165

166166

167167
0.4.6 - 2024-12-17
168-
--------------------
168+
------------------
169169

170170
Added
171171
^^^^^
@@ -187,7 +187,7 @@ Changed
187187

188188

189189
0.4.5 - 2024-12-09
190-
--------------------
190+
------------------
191191

192192
Added
193193
^^^^^
@@ -201,7 +201,7 @@ Changed
201201
* Fixes issues with sphinx docs and run the `install_spark_jars.py` script in the build container.
202202

203203
0.4.4 - 2024-12-02
204-
--------------------
204+
------------------
205205

206206
Added
207207
^^^^^
@@ -216,7 +216,7 @@ Changed
216216

217217

218218
0.4.3 - 2024-10-19
219-
--------------------
219+
------------------
220220

221221
Added
222222
^^^^^
@@ -227,7 +227,7 @@ Changed
227227
* Changed paths to the S3 bucket evaluations to reference "e*..." instead of "p*..." naming convention.
228228

229229
0.4.2 - 2024-10-18
230-
--------------------
230+
------------------
231231

232232
Added
233233
^^^^^
@@ -238,7 +238,7 @@ Changed
238238
* None
239239

240240
0.4.1 - 2024-10-15
241-
--------------------
241+
------------------
242242

243243
Added
244244
^^^^^
@@ -251,7 +251,7 @@ Changed
251251
* Fixed the API doc build.
252252

253253
0.4.0 - 2024-10-13
254-
--------------------
254+
------------------
255255

256256
Added
257257
^^^^^

‎docs/sphinx/user_guide/notebooks/05_clone_from_s3.ipynb‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -307,11 +307,11 @@
307307
" \"value\": \"usgs-14138800\"\n",
308308
" }],\n",
309309
" include_metrics=[\n",
310-
" teehr.SignatureMetrics.Maximum(\n",
310+
" teehr.Signatures.Maximum(\n",
311311
" input_field_names=[\"primary_value\"],\n",
312312
" output_field_name=\"max_primary_value\"\n",
313313
" ),\n",
314-
" teehr.SignatureMetrics.Maximum(\n",
314+
" teehr.Signatures.Maximum(\n",
315315
" input_field_names=[\"secondary_value\"],\n",
316316
" output_field_name=\"max_secondary_value\"\n",
317317
" )\n",
@@ -347,11 +347,11 @@
347347
" \"value\": \"usgs-14138800\"\n",
348348
" }],\n",
349349
" include_metrics=[\n",
350-
" teehr.SignatureMetrics.Maximum(\n",
350+
" teehr.Signatures.Maximum(\n",
351351
" input_field_names=[\"primary_value\"],\n",
352352
" output_field_name=\"max_primary_value\"\n",
353353
" ),\n",
354-
" teehr.SignatureMetrics.Maximum(\n",
354+
" teehr.Signatures.Maximum(\n",
355355
" input_field_names=[\"secondary_value\"],\n",
356356
" output_field_name=\"max_secondary_value\"\n",
357357
" )\n",

‎docs/sphinx/user_guide/notebooks/07_read_from_s3.ipynb‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -279,11 +279,11 @@
279279
" \"value\": \"usgs-14138800\"\n",
280280
" }],\n",
281281
" include_metrics=[\n",
282-
" teehr.SignatureMetrics.Maximum(\n",
282+
" teehr.Signatures.Maximum(\n",
283283
" input_field_names=[\"primary_value\"],\n",
284284
" output_field_name=\"max_primary_value\"\n",
285285
" ),\n",
286-
" teehr.SignatureMetrics.Maximum(\n",
286+
" teehr.Signatures.Maximum(\n",
287287
" input_field_names=[\"secondary_value\"],\n",
288288
" output_field_name=\"max_secondary_value\"\n",
289289
" )\n",
@@ -319,11 +319,11 @@
319319
" \"value\": \"usgs-14138800\"\n",
320320
" }],\n",
321321
" include_metrics=[\n",
322-
" teehr.SignatureMetrics.Maximum(\n",
322+
" teehr.Signatures.Maximum(\n",
323323
" input_field_names=[\"primary_value\"],\n",
324324
" output_field_name=\"max_primary_value\"\n",
325325
" ),\n",
326-
" teehr.SignatureMetrics.Maximum(\n",
326+
" teehr.Signatures.Maximum(\n",
327327
" input_field_names=[\"secondary_value\"],\n",
328328
" output_field_name=\"max_secondary_value\"\n",
329329
" )\n",

‎docs/sphinx/user_guide/notebooks/08_adding_calculated_fields.ipynb‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -893,7 +893,7 @@
893893
},
894894
{
895895
"cell_type": "code",
896-
"execution_count": 17,
896+
"execution_count": null,
897897
"metadata": {},
898898
"outputs": [
899899
{
@@ -953,11 +953,11 @@
953953
" \"event = true\",\n",
954954
" ],\n",
955955
" include_metrics=[\n",
956-
" teehr.SignatureMetrics.Maximum(\n",
956+
" teehr.Signatures.Maximum(\n",
957957
" input_field_names=[\"primary_value\"],\n",
958958
" output_field_name=\"max_primary_value\"\n",
959959
" ),\n",
960-
" teehr.SignatureMetrics.Maximum(\n",
960+
" teehr.Signatures.Maximum(\n",
961961
" input_field_names=[\"secondary_value\"],\n",
962962
" output_field_name=\"max_secondary_value\"\n",
963963
" )\n",
@@ -976,7 +976,7 @@
976976
},
977977
{
978978
"cell_type": "code",
979-
"execution_count": 18,
979+
"execution_count": null,
980980
"metadata": {},
981981
"outputs": [
982982
{
@@ -1010,11 +1010,11 @@
10101010
" \"event = true\",\n",
10111011
" ],\n",
10121012
" include_metrics=[\n",
1013-
" teehr.SignatureMetrics.Maximum(\n",
1013+
" teehr.Signatures.Maximum(\n",
10141014
" input_field_names=[\"primary_value\"],\n",
10151015
" output_field_name=\"max_primary_value\"\n",
10161016
" ),\n",
1017-
" teehr.SignatureMetrics.Maximum(\n",
1017+
" teehr.Signatures.Maximum(\n",
10181018
" input_field_names=[\"secondary_value\"],\n",
10191019
" output_field_name=\"max_secondary_value\"\n",
10201020
" )\n",
@@ -1042,7 +1042,7 @@
10421042
},
10431043
{
10441044
"cell_type": "code",
1045-
"execution_count": 19,
1045+
"execution_count": null,
10461046
"metadata": {},
10471047
"outputs": [
10481048
{
@@ -1093,11 +1093,11 @@
10931093
" \"event90 = true\",\n",
10941094
" ],\n",
10951095
" include_metrics=[\n",
1096-
" teehr.SignatureMetrics.Maximum(\n",
1096+
" teehr.Signatures.Maximum(\n",
10971097
" input_field_names=[\"primary_value\"],\n",
10981098
" output_field_name=\"max_primary_value\"\n",
10991099
" ),\n",
1100-
" teehr.SignatureMetrics.Maximum(\n",
1100+
" teehr.Signatures.Maximum(\n",
11011101
" input_field_names=[\"secondary_value\"],\n",
11021102
" output_field_name=\"max_secondary_value\"\n",
11031103
" )\n",

‎pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "teehr"
3-
version = "0.5.1dev9"
3+
version = "0.5.1dev10"
44
description = "Tools for Exploratory Evaluation in Hydrologic Research"
55
authors = [
66
"RTI International",

‎src/teehr/__init__.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
"""Initialize the TEEHR package."""
22
import warnings
33

4-
__version__ = "0.5.1dev9"
4+
__version__ = "0.5.1dev10"
55

66
with warnings.catch_warnings():
77
warnings.simplefilter("ignore", UserWarning)
@@ -10,7 +10,7 @@
1010
from teehr.evaluation.evaluation import Evaluation # noqa
1111
from teehr.models.metrics.deterministic_models import DeterministicMetrics # noqa
1212
from teehr.models.metrics.probabilistic_models import ProbabilisticMetrics # noqa
13-
from teehr.models.metrics.signature_models import SignatureMetrics # noqa
13+
from teehr.models.metrics.signature_models import Signatures # noqa
1414
from teehr.models.metrics.bootstrap_models import Bootstrappers # noqa
1515
from teehr.models.metrics.basemodels import Operators # noqa
1616
from teehr.models.pydantic_table_models import ( # noqa

‎src/teehr/examples/03-metric_queries.ipynb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@
118118
"outputs": [],
119119
"source": [
120120
"from teehr import DeterministicMetrics as metrics\n",
121-
"from teehr import SignatureMetrics as sig_metrics"
121+
"from teehr import Signatures as sig_metrics"
122122
]
123123
},
124124
{

‎src/teehr/models/metrics/signature_models.py‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -296,13 +296,13 @@ class FlowDurationCurveSlope(DeterministicBasemodel):
296296
attrs: Dict = Field(default=tma.FDC_SLOPE_ATTRS, frozen=True)
297297

298298

299-
class SignatureMetrics:
300-
"""Define and customize signature metrics.
299+
class Signatures:
300+
"""Define and customize signatures.
301301
302302
Notes
303303
-----
304-
Signature metrics operate on a single field. Available
305-
signature metrics are:
304+
Signatures operate on a single field. Available
305+
signatures are:
306306
307307
- Average
308308
- Count
@@ -311,6 +311,7 @@ class SignatureMetrics:
311311
- Minimum
312312
- Sum
313313
- Variance
314+
- FlowDurationCurveSlope
314315
"""
315316

316317
Average = Average

‎tests/evaluations/test_add_udfs.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -342,11 +342,11 @@ def test_location_event_detection(tmpdir):
342342
sdf = ev.metrics.add_calculated_fields(ped).query(
343343
group_by=["configuration_name", "primary_location_id", "event_above_id"],
344344
include_metrics=[
345-
teehr.SignatureMetrics.Maximum(
345+
teehr.Signatures.Maximum(
346346
input_field_names=["primary_value"],
347347
output_field_name="max_primary_value"
348348
),
349-
teehr.SignatureMetrics.Maximum(
349+
teehr.Signatures.Maximum(
350350
input_field_names=["secondary_value"],
351351
output_field_name="max_secondary_value"
352352
)

0 commit comments

Comments
 (0)