gobkinematics 0.1.0__tar.gz

gobkinematics-0.1.0/LICENSE

@@ -0,0 +1,22 @@
+
+MIT License
+
+Copyright (c) 2026 J. Adonai Pacompia
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

gobkinematics-0.1.0/PKG-INFO

@@ -0,0 +1,114 @@
+Metadata-Version: 2.4
+Name: gobkinematics
+Version: 0.1.0
+Summary: A Python library for the graphical representation and kinematic classification of geological faults.
+Author: J. Adonai Pacompia
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/Metalic-Ado/GOBKINEMATICS
+Project-URL: Repository, https://github.com/Metalic-Ado/GOBKINEMATICS
+Project-URL: Issues, https://github.com/Metalic-Ado/GOBKINEMATICS/issues
+Keywords: geology,structural-geology,kinematics,geological-faults,matplotlib
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: matplotlib
+Provides-Extra: pandas
+Requires-Dist: pandas; extra == "pandas"
+Dynamic: license-file
+
+# GOBKINEMATICS
+
+**A Python library for the graphical representation and kinematic classification of geological faults.**
+
+GOBKINEMATICS is a Python library designed to support structural geology analysis through the graphical representation and kinematic classification of geological faults.
+
+It integrates with Matplotlib, allowing users to create and customize geological fault representations using a dedicated plotting projection.
+
+## Features
+
+- Structural fault data representation.
+- Kinematic classification and visualization.
+- Complete and compact representation modes.
+- Customization of STRIKE, FAULT, and AUX graphical elements.
+- Optional connectors between STRIKE and FAULT.
+- Integration with Matplotlib.
+- Input normalization and validation.
+
+## Installation
+
+Once GOBKINEMATICS is published on PyPI, install it using:
+
+```bash
+pip install gobkinematics
+```
+
+## Requirements
+
+- Python
+- NumPy
+- Matplotlib
+
+Pandas is optional.
+
+## Quick start
+
+Import GOBKINEMATICS and Matplotlib:
+
+```python
+import matplotlib.pyplot as plt
+import GOBKINEMATICS
+```
+
+Create two plotting axes using the `kinematic` projection:
+
+```python
+fig, (ax1, ax2) = plt.subplots(
+    1, 2,
+    figsize=(16, 8),
+    subplot_kw={"projection": "kinematic"}
+)
+```
+
+Plot geological faults using the complete and compact representation modes:
+
+```python
+ax1.plot_general_faults(
+    strike, dip, rake, cine_1, cine_2, "complete"
+)
+
+ax2.plot_general_faults(
+    strike, dip, rake, cine_1, cine_2, "compact"
+)
+
+plt.show()
+```
+
+The variables `strike`, `dip`, `rake`, `cine_1`, and `cine_2` represent the structural and kinematic input data.
+
+## Development status
+
+**Version:** 0.1.0  
+**Status:** Experimental prototype  
+**Language:** Python
+
+GOBKINEMATICS is under active development. This initial experimental release is intended for evaluation by geologists, researchers, and developers working in structural geology.
+
+Future releases may incorporate additional features, data import tools, annotations, and report generation.
+
+## Feedback and contributions
+
+Feedback, suggestions, bug reports, and recommendations are welcome.
+
+Contributions from the structural geology and scientific programming communities are encouraged.
+
+## Repository
+
+[GitHub – Metalic-Ado/GOBKINEMATICS](https://github.com/Metalic-Ado/GOBKINEMATICS)

gobkinematics-0.1.0/README.md

@@ -0,0 +1,88 @@
+# GOBKINEMATICS
+
+**A Python library for the graphical representation and kinematic classification of geological faults.**
+
+GOBKINEMATICS is a Python library designed to support structural geology analysis through the graphical representation and kinematic classification of geological faults.
+
+It integrates with Matplotlib, allowing users to create and customize geological fault representations using a dedicated plotting projection.
+
+## Features
+
+- Structural fault data representation.
+- Kinematic classification and visualization.
+- Complete and compact representation modes.
+- Customization of STRIKE, FAULT, and AUX graphical elements.
+- Optional connectors between STRIKE and FAULT.
+- Integration with Matplotlib.
+- Input normalization and validation.
+
+## Installation
+
+Once GOBKINEMATICS is published on PyPI, install it using:
+
+```bash
+pip install gobkinematics
+```
+
+## Requirements
+
+- Python
+- NumPy
+- Matplotlib
+
+Pandas is optional.
+
+## Quick start
+
+Import GOBKINEMATICS and Matplotlib:
+
+```python
+import matplotlib.pyplot as plt
+import GOBKINEMATICS
+```
+
+Create two plotting axes using the `kinematic` projection:
+
+```python
+fig, (ax1, ax2) = plt.subplots(
+    1, 2,
+    figsize=(16, 8),
+    subplot_kw={"projection": "kinematic"}
+)
+```
+
+Plot geological faults using the complete and compact representation modes:
+
+```python
+ax1.plot_general_faults(
+    strike, dip, rake, cine_1, cine_2, "complete"
+)
+
+ax2.plot_general_faults(
+    strike, dip, rake, cine_1, cine_2, "compact"
+)
+
+plt.show()
+```
+
+The variables `strike`, `dip`, `rake`, `cine_1`, and `cine_2` represent the structural and kinematic input data.
+
+## Development status
+
+**Version:** 0.1.0  
+**Status:** Experimental prototype  
+**Language:** Python
+
+GOBKINEMATICS is under active development. This initial experimental release is intended for evaluation by geologists, researchers, and developers working in structural geology.
+
+Future releases may incorporate additional features, data import tools, annotations, and report generation.
+
+## Feedback and contributions
+
+Feedback, suggestions, bug reports, and recommendations are welcome.
+
+Contributions from the structural geology and scientific programming communities are encouraged.
+
+## Repository
+
+[GitHub – Metalic-Ado/GOBKINEMATICS](https://github.com/Metalic-Ado/GOBKINEMATICS)

gobkinematics-0.1.0/__init__.py

@@ -0,0 +1,26 @@
+# ==================================================
+# GOBKINEMATICS
+# API PUBLICA
+# ==================================================
+
+from .kinematics.kinematics_axes import KinematicAxes
+
+from .kinematics.kinematics_math import (
+    changes_magnitud_rake,
+    dip_rake_to_xy,
+    strike_to_xy
+)
+
+from .kinematics.kinematics_visual import half_circle_marker
+
+
+__version__ = "0.1.0"
+
+
+__all__ = [
+    "KinematicAxes",
+    "changes_magnitud_rake",
+    "dip_rake_to_xy",
+    "strike_to_xy",
+    "half_circle_marker",
+]

gobkinematics-0.1.0/faultcore/clasify_nones.py

@@ -0,0 +1,97 @@
+
+def clasify_for_items(strike, dip, rake, cine_1, cine_2):
+    """
+    Clasifica cada registro según la cantidad de datos presentes.
+
+    N5: 5 datos presentes.
+    N4: 4 datos presentes.
+    N3: 3 datos presentes.
+    N2: 2 datos presentes.
+    N1: 1 dato presente.
+    INVALID0: ningún dato presente.
+
+    Recibe datos previamente normalizados por norm_basic.py.
+
+    Esta función:
+    - Cuenta los valores diferentes de None.
+    - Asigna la clasificación correspondiente.
+    - Identifica registros sin strike.
+    - Conserva los datos y el orden de los registros.
+
+    No normaliza, valida tipos, evalúa geometría,
+    evalúa cinemática ni modifica los datos.
+    """
+
+    # 1. Organizar los campos recibidos
+    data = {
+        "strike": strike,
+        "dip": dip,
+        "rake": rake,
+        "cine_1": cine_1,
+        "cine_2": cine_2
+    }
+
+    campos = (
+        "strike",
+        "dip",
+        "rake",
+        "cine_1",
+        "cine_2"
+    )
+
+    resultados = []
+
+    # 2. Recorrer los registros
+    n_registros = len(strike)
+
+    for i in range(n_registros):
+
+        registro_datos = {
+            campo: data[campo][i]
+            for campo in campos
+        }
+
+        # 3. Contar datos presentes
+        n_valid = sum(
+            valor is not None
+            for valor in registro_datos.values()
+        )
+
+        # 4. Asignar clasificación
+        if n_valid == 5:
+            clase = "N5"
+
+        elif n_valid == 4:
+            clase = "N4"
+
+        elif n_valid == 3:
+            clase = "N3"
+
+        elif n_valid == 2:
+            clase = "N2"
+
+        elif n_valid == 1:
+            clase = "N1"
+
+        else:
+            clase = "INVALID0"
+
+        # 5. Identificar ausencia de strike
+        if registro_datos["strike"] is None:
+            estado = "invalido"
+            motivo = "strike_ausente"
+
+        else:
+            estado = "sin_evaluar"
+            motivo = None
+
+        # 6. Guardar resultado
+        resultados.append({
+            "id": i + 1,
+            "clase": clase,
+            "datos": registro_datos,
+            "estado": estado,
+            "motivo": motivo
+        })
+
+    return resultados