apsg 1.2.0__tar.gz → 1.2.1__tar.gz

{apsg-1.2.0 → apsg-1.2.1}/HISTORY.md

@@ -1,6 +1,9 @@
 # Changes
 
-### 1.2.0 (master)
+### 1.2.1 (Sep 23 2024)
+ * Fault sense could be defined by str, one of 's', 'd', 'n' and 'r'
+
+### 1.2.0 (May 24 2024)
  * sqlalchemy and pandas added to requirements
  * quicknet fault bug fixed
 

{apsg-1.2.0 → apsg-1.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: apsg
-Version: 1.2.0
+Version: 1.2.1
 Summary: APSG - The package for structural geologists
 Home-page: https://github.com/ondrolexa/apsg
 Author: Ondrej Lexa
@@ -140,7 +140,10 @@ APSG is free software: you can redistribute it and/or modify it under the terms
 
 # Changes
 
-### 1.2.0 (master)
+### 1.2.1 (Sep 23 2024)
+ * Fault sense could be defined by str, one of 's', 'd', 'n' and 'r'
+
+### 1.2.0 (May 24 2024)
  * sqlalchemy and pandas added to requirements
  * quicknet fault bug fixed
 

{apsg-1.2.0 → apsg-1.2.1}/docs/conf.py

@@ -71,7 +71,7 @@ copyright = "2023, Ondrej Lexa"
 # The short X.Y version.
 version = "1.2"
 # The full version, including alpha/beta/rc tags.
-release = "1.2.0"
+release = "1.2.1"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

{apsg-1.2.0 → apsg-1.2.1}/setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.2.0
+current_version = 1.2.1
 commit = False
 tag = False
 

{apsg-1.2.0 → apsg-1.2.1}/setup.py

@@ -17,7 +17,7 @@ with open(path.join(CURRENT_PATH, "HISTORY.md")) as file:
 
 setup(
     name="apsg",
-    version="1.2.0",
+    version="1.2.1",
     description="APSG - The package for structural geologists",
     long_description=readme + "\n\n" + history,
     long_description_content_type="text/markdown",

{apsg-1.2.0 → apsg-1.2.1}/src/apsg/__init__.py

@@ -98,6 +98,6 @@ __all__ = (
     "quicknet",
 )
 
-__version__ = "1.2.0"
+__version__ = "1.2.1"
 __author__ = "Ondrej Lexa"
 __email__ = "lexa.ondrej@gmail.com"

{apsg-1.2.0 → apsg-1.2.1}/src/apsg/feature/_container.py

@@ -1563,6 +1563,18 @@ class ClusterSet(object):
     Provides a hierarchical clustering using `scipy.cluster` routines.
     The distance matrix is calculated as an angle between features, where ``Foliation``
     and ``Lineation`` use axial angles while ``Vector3`` uses direction angles.
+
+    Args:
+        azi (float): plunge direction of linear feature in degrees
+        inc (float): plunge of linear feature in degrees
+
+    Keyword Args:
+        maxclust (int): Desired number of clusters. Default 2
+        angle (float): Forms flat clusters so that the original observations in each
+            cluster have no greater angle. Default is None to use maxclust criterion.
+        method (str): Method for calculating the distance between the newly formed
+            cluster and observations. Default is 'average' for UPGMA algorithm
+
     """
 
     def __init__(self, d, **kwargs):
@@ -1580,13 +1592,13 @@ class ClusterSet(object):
     def __repr__(self):
         info = f"Already {len(self.groups)} clusters created."
         if self.angle is not None:
-            crit = "Criterion: Angle\nSettings: distance=%.4g\n" % (self.angle)
+            crit = f"Criterion: Angle\nSettings: distance={self.angle:.4g}\n"
         else:
-            crit = "Criterion: Maxclust\nSettings: muxclust=%.4g\n" % (self.maxclust)
+            crit = f"Criterion: Maxclust\nSettings: maxclust={self.maxclust:.4g}\n"
         return (
             "ClusterSet\n"
-            + "Number of data: %d\n" % len(self.data)
-            + "Linkage method: %s\n" % self.method
+            + f"Number of data: {len(self.data)}\n"
+            + f"Linkage method: {self.method}\n"
             + crit
             + info
         )

{apsg-1.2.0 → apsg-1.2.1}/src/apsg/feature/_geodata.py

@@ -367,8 +367,9 @@ class Fault(Pair):
         - `p` could be Fault
         - `p` could be tuple of (fazi, finc, lazi, linc, sense)
         - `p` could be tuple of (fx, fy ,fz, lx, ly, lz)
-    - with 2 arguments f and l could be Vector3 like objects,
-      e.g. ``Foliation`` and ``Lineation``
+    - with 2 arguments p (Pair object) and sense
+    - with 3 arguments f, l (Vector3 like objects), e.g. ``Foliation``
+      and ``Lineation`` and sense
     - with 5 numerical arguments defining `fol(fazi, finc)`, `lin(lazi, linc)` and sense
 
     Args:
@@ -376,7 +377,9 @@ class Fault(Pair):
         finc (float): dip of planar feature in degrees
         lazi (float): plunge direction of linear feature in degrees
         linc (float): plunge of linear feature in degrees
-        sense (float): sense of movement -/+1 hanging-wall up/down reverse/normal
+        sense (float or str): sense of movement +/11 hanging-wall down/up. When str,
+            ,ust be one of 's', 'd', 'n', 'r'.
+
 
     Attributes:
         fvec (Vector3): corrected vector normal to plane
@@ -384,11 +387,11 @@ class Fault(Pair):
         sense (int): sense of movement (+/-1)
 
     Example:
-        >>> fault()
-        >>> fault(p)
-        >>> fault(f, l)
-        >>> fault(fazi, finc, lazi, linc, sense)
         >>> f = fault(140, 30, 110, 26, -1)
+        >>> f = fault(140, 30, 110, 26, 'r')
+        >>> p = pair(140, 30, 110, 26)
+        >>> f = fault(p, 'n')
+        >>> f = fault(fol(120, 80), lin(32, 10), 's')
 
     """
 
@@ -396,18 +399,20 @@ class Fault(Pair):
 
     def __init__(self, *args):
         if len(args) == 0:
-            fvec, lvec, sense = Vector3(0, 0, 1), Vector3(1, 0, 0), 1
+            fvec, lvec = Vector3(0, 0, 1), Vector3(1, 0, 0)
         elif len(args) == 1 and np.asarray(args[0]).shape == (5,):
             fazi, finc, lazi, linc, sense = (float(v) for v in args[0])
             fvec, lvec = Foliation(fazi, finc), Lineation(lazi, linc)
+            sense = self.calc_sense(fvec, lvec, sense)
             if sense < 0:
                 lvec = -lvec
         elif len(args) == 1 and issubclass(type(args[0]), Pair):
             fvec, lvec = args[0].fvec, args[0].lvec
         elif len(args) == 2 and issubclass(type(args[0]), Pair):
             fvec, lvec = args[0].fvec, args[0].lvec
+            sense = self.calc_sense(fvec, lvec, args[1])
             georax = lvec.lower().cross(fvec.lower())
-            if args[0].rax == georax and args[1] < 0:
+            if args[0].rax == georax and sense < 0:
                 lvec = -lvec
         elif len(args) == 2:
             if issubclass(type(args[0]), Vector3) and issubclass(
@@ -419,19 +424,43 @@ class Fault(Pair):
                 type(args[1]), Vector3
             ):
                 fvec, lvec = args[0], args[1]
+                sense = self.calc_sense(fvec, lvec, args[2])
                 rax = lvec.cross(fvec)
                 georax = lvec.lower().cross(fvec.lower())
-                if rax == georax and args[2] < 0:
+                if rax == georax and sense < 0:
                     lvec = -lvec
         elif len(args) == 5:
             fvec = Foliation(args[0], args[1])
             lvec = Lineation(args[2], args[3])
-            if args[4] < 0:
+            sense = self.calc_sense(fvec, lvec, args[4])
+            if sense < 0:
                 lvec = -lvec
         else:
             raise TypeError("Not valid arguments for Fault")
         super().__init__(fvec, lvec)
 
+    @classmethod
+    def calc_sense(cls, fvec, lvec, sense):
+        if isinstance(sense, int) or isinstance(sense, float):
+            return sense
+        elif isinstance(sense, str):
+            p = Pair(fvec, lvec)
+            if sense.lower() == "s":
+                if p.rax == p.rax.lower():
+                    res = -1
+                else:
+                    res = 1
+            elif sense.lower() == "d":
+                if p.rax == p.rax.lower():
+                    res = 1
+                else:
+                    res = -1
+            elif sense.lower() == "n":
+                res = 1
+            elif sense.lower() == "r":
+                res = -1
+            return res
+
     def __repr__(self):
         fazi, finc = self.fol.geo
         lazi, linc = self.lin.geo

{apsg-1.2.0 → apsg-1.2.1}/src/apsg.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: apsg
-Version: 1.2.0
+Version: 1.2.1
 Summary: APSG - The package for structural geologists
 Home-page: https://github.com/ondrolexa/apsg
 Author: Ondrej Lexa
@@ -140,7 +140,10 @@ APSG is free software: you can redistribute it and/or modify it under the terms
 
 # Changes
 
-### 1.2.0 (master)
+### 1.2.1 (Sep 23 2024)
+ * Fault sense could be defined by str, one of 's', 'd', 'n' and 'r'
+
+### 1.2.0 (May 24 2024)
  * sqlalchemy and pandas added to requirements
  * quicknet fault bug fixed