anss-formats 0.1.0__tar.gz → 0.1.1__tar.gz

anss_formats-0.1.1/PKG-INFO

@@ -0,0 +1,24 @@
+Metadata-Version: 2.4
+Name: anss-formats
+Version: 0.1.1
+Summary: Python implementation of the library used to communicate seismic event detection information between systems
+License: CC0-1.0
+Keywords: anss,earthquakes,formats,detection
+Author: John Patton
+Author-email: jpatton@usgs.gov
+Requires-Python: >3.9.1,<3.12
+Classifier: License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Provides-Extra: pycurl
+Requires-Dist: certifi (>=2024.07.04,<2025.0.0)
+Requires-Dist: cryptography (>=42.0.5)
+Requires-Dist: docutils (!=0.21.post1)
+Requires-Dist: dparse (>=0.6.2,<0.7.0)
+Requires-Dist: pydantic (>=2.6.0,<3.0.0)
+Requires-Dist: requests (>=2.32.2,<3.0.0)
+Requires-Dist: twine (>=5.1.1,<6.0.0)
+Requires-Dist: urllib3 (>=2.6.0,<3.0.0)
+Project-URL: Homepage, https://gitlab.com/anss-netops/anss-data-formats
+Project-URL: Repository, https://gitlab.com/anss-netops/anss-data-formats

anss_formats-0.1.1/anssformats/__init__.py

@@ -0,0 +1,26 @@
+from anssformats.pick import Pick
+from anssformats.source import Source
+from anssformats.amplitude import Amplitude
+from anssformats.analytics import Analytics, Prediction
+from anssformats.association import Association
+from anssformats.detection import Detection
+from anssformats.hypocenter import Hypocenter
+from anssformats.magnitude import Magnitude
+from anssformats.channel import Channel
+from anssformats.filter import Filter
+from anssformats.eventType import EventType
+
+__all__ = [
+    "Pick",
+    "Source",
+    "Amplitude",
+    "Analytics",
+    "Prediction",
+    "Association",
+    "Detection",
+    "Hypocenter",
+    "Magnitude",
+    "Channel",
+    "Filter",
+    "EventType",
+]

anss_formats-0.1.1/anssformats/analytics.py

@@ -0,0 +1,82 @@
+from typing import Optional, Union, List
+
+from pydantic import Field
+
+from anssformats.formatbasemodel import FormatBaseModel
+from anssformats.source import Source as SourceFormat
+
+
+class Prediction(FormatBaseModel):
+    """A generic prediction from an analytical model (AI/ML, statistical, rule-based, etc.)
+
+    This class provides a flexible structure for representing any type of prediction
+    with associated metrics and model provenance.
+
+    Attributes
+    ----------
+    label: string identifying what is being predicted (e.g., "phase", "magnitude",
+        "eventType", "custom_attribute")
+
+    value: the predicted value - can be string, number, or structured object
+
+    probability: optional float [0.0-1.0] containing the probability of this prediction
+
+    metrics: optional dict containing additional prediction metrics such as confidence,
+        uncertainty quantification (std, ranges, credible intervals), entropy, etc.
+        Structure is flexible to support any model-specific metrics.
+
+    modelID: optional string identifying which model made this prediction
+
+    modelVersion: optional string containing the version of the model
+
+    source: optional Source object containing the source/author of the
+    """
+
+    label: str = Field(
+        ...,
+        description="What is being predicted (e.g., phase, magnitude, eventType, distance)",
+    )
+    value: Union[str, float, int, list, dict] = Field(
+        ..., description="The predicted value"
+    )
+    probability: Optional[float] = Field(
+        None, ge=0.0, le=1.0, description="Probability of this prediction [0.0-1.0]"
+    )
+    metrics: Optional[dict] = Field(
+        None,
+        description="Additional prediction metrics (confidence, uncertainty, entropy, etc.)",
+    )
+    modelID: Optional[str] = Field(
+        None, description="Identifier for the model that made this prediction"
+    )
+    modelVersion: Optional[str] = Field(None, description="Version of the model")
+    source: Optional[SourceFormat] = Field(
+        None, description="Source/author of the model"
+    )
+
+
+class Analytics(FormatBaseModel):
+    """A conversion class used to create, parse, and validate analytical information
+    from models such as pickers, analytical models, AI/ML, etc.
+
+    This class provides an extensible structure supporting multiple models, arbitrary
+    prediction labels, and custom extensions.
+
+    Attributes
+    ----------
+
+    predictions: optional list of Prediction objects containing predictions from one
+        or more models. Each prediction can represent any type of analytical output
+        with associated confidence metrics and model provenance.
+
+    extensions: optional dict containing custom key-value pairs for experimental code and debugging.
+
+    """
+
+    predictions: Optional[List[Prediction]] = Field(
+        None, description="Array of predictions from one or more analytical models"
+    )
+
+    extensions: Optional[dict] = Field(
+        None, description="Custom key-value pairs for experimental or debuging data"
+    )

{anss_formats-0.1.0 → anss_formats-0.1.1}/anssformats/detection.py

@@ -9,6 +9,7 @@ from anssformats.hypocenter import Hypocenter, HypocenterProperties
 from anssformats.source import Source
 from anssformats.pick import Pick
 from anssformats.magnitude import Magnitude
+from anssformats.analytics import Analytics
 
 
 class Detection(FormatBaseModel):
@@ -41,7 +42,7 @@ class Detection(FormatBaseModel):
     pickData: optional list of either Pick objects used to generate
         this detection
 
-
+    analyticsInfo: optional analytics object containing model output attached to this detection
     """
 
     type: Literal["Detection"]
@@ -64,3 +65,5 @@ class Detection(FormatBaseModel):
     pickData: Optional[List[Pick]] = None
 
     magnitudeData: Optional[List[Magnitude]] = None
+
+    analyticsInfo: Optional[Analytics] = None

{anss_formats-0.1.0 → anss_formats-0.1.1}/anssformats/pick.py

@@ -4,12 +4,11 @@ from pydantic import Field
 
 from anssformats.amplitude import Amplitude
 from anssformats.association import Association
-from anssformats.machineLearning import MachineLearning
+from anssformats.analytics import Analytics
 from anssformats.filter import Filter
 from anssformats.formatbasemodel import CustomDT, FormatBaseModel
 from anssformats.channel import Channel, ChannelProperties
 from anssformats.source import Source
-from anssformats.quality import Quality
 
 
 class Pick(FormatBaseModel):
@@ -39,17 +38,12 @@ class Pick(FormatBaseModel):
     filterInfo: optional list of Filter objects containing the filter frequencies when the
         pick was made
 
-    amplitude: optional Amplitude object containing the amplitude associated with the
-        pick
+    amplitude: optional Amplitude object containing the amplitude associated with the pick
 
     associationInfo: optional Association object containing the association information
         if this pick is used as data in a Detection
 
-    machineLearningInfo: optional machineLearning object containing the machineLearning
-        information of this pick
-
-    qualityInfo: optional quality object containing the quality
-        information of this pick
+    AnalyticsInfo: optional analytics object containing model output attached to this pick
     """
 
     type: Literal["Pick"]
@@ -70,5 +64,4 @@ class Pick(FormatBaseModel):
     amplitudeInfo: Optional[Amplitude] = None
 
     associationInfo: Optional[Association] = None
-    machineLearningInfo: Optional[MachineLearning] = None
-    qualityInfo: Optional[List[Quality]] = None
+    analyticsInfo: Optional[Analytics] = None

{anss_formats-0.1.0 → anss_formats-0.1.1}/pyproject.toml

@@ -1,39 +1,39 @@
-[tool.poetry]
-name = "anss-formats"
-version = "0.1.0"
-description = "Python implementation of the library used to communicate seismic event detection information between systems"
-authors = ["John Patton <jpatton@usgs.gov>"]
-readme = "README_purpose.md"
-license = "CC0-1.0"
-homepage ="https://gitlab.com/anss-netops/anss-data-formats"
-include = [
-  "LICENSE.md"
-]
-repository="https://gitlab.com/anss-netops/anss-data-formats"
-keywords = ["anss", "earthquakes", "formats", "detection"]
-packages = [
-  {include = "anssformats" }
-]
-
-[tool.poetry.dependencies]
-python = ">3.9.1,<3.12"
-twine = "^5.1.1"
-dparse = "^0.6.2"
-certifi = "^2024.07.04"
-cryptography = "^44.0.1"
-pydantic = "^2.6.0"
-docutils = "!=0.21.post1"
-requests = "^2.32.2"
-
-[tool.poetry.group.dev.dependencies]
-black = "^24.10.0"
-safety = "^2.2.0"
-pytest = "^7.3.1"
-pytest-cov = "^4.1.0"
-
-[tool.poetry.extras]
-pycurl = ["pycurl"]
-
-[build-system]
-requires = ["poetry-core>=1.0.0"]
-build-backend = "poetry.core.masonry.api"
+[tool.poetry]
+name = "anss-formats"
+version = "0.1.1"
+description = "Python implementation of the library used to communicate seismic event detection information between systems"
+authors = ["John Patton <jpatton@usgs.gov>"]
+license = "CC0-1.0"
+homepage ="https://gitlab.com/anss-netops/anss-data-formats"
+include = [
+  "LICENSE.md"
+]
+repository="https://gitlab.com/anss-netops/anss-data-formats"
+keywords = ["anss", "earthquakes", "formats", "detection"]
+packages = [
+  {include = "anssformats" }
+]
+
+[tool.poetry.dependencies]
+python = ">3.9.1,<3.12"
+twine = "^5.1.1"
+dparse = "^0.6.2"
+certifi = "^2024.07.04"
+cryptography = ">=42.0.5"
+pydantic = "^2.6.0"
+docutils = "!=0.21.post1"
+requests = "^2.32.2"
+urllib3 = "^2.6.0"
+
+[tool.poetry.group.dev.dependencies]
+black = "^24.10.0"
+safety = "^2.2.0"
+pytest = "^7.3.1"
+pytest-cov = "^4.1.0"
+
+[tool.poetry.extras]
+pycurl = ["pycurl"]
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"