apsg 1.3.0__py3-none-any.whl

AUTHORS.md

@@ -0,0 +1,9 @@
+# Credits
+
+## Development Lead
+
+* Ondrej Lexa <lexa.ondrej@gmail.com>
+
+## Contributors
+
+* David Landa <david.landa@natur.cuni.cz>

CHANGELOG.md

@@ -0,0 +1,304 @@
+# Changelog
+
+## 1.3.0 (Dec 14 2024)
+ * Python 3.10 set as minimal version
+ * Tensor3 eigenlins and eigenfols implemented as methods
+ * pandas accessors G property returns apsg FeatureSet
+
+### 1.2.3 (Nov 18 2024)
+ * ClusterSet accepts PairSet and FaultSet
+ * quicknet label option added
+ * vector pow bug fix
+
+### 1.2.2 (Oct 21 2024)
+ * Fault sense could be defined by str, one of 's', 'd', 'n' and 'r'
+
+### 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
+
+### 1.1.5 (May 15 2024)
+ * paleomag Core .dd bug fixed
+ * fix round-off domain math error for acosd and asind
+
+### 1.1.4 (Dec 13 2023)
+ * Ellipsoid repr bugfix
+
+### 1.1.3 (Oct 23 2023)
+Bugfix release
+ * slip and dilatation tendency methods added to stress
+ * proj alias of project for FeatureSet added
+
+### 1.1.2 (Oct 09 2023)
+ * added title_kws argument for plotting routines
+
+### 1.1.1 (Oct 06 2023)
+ * sigma estimate contour fix
+
+## 1.1.0 (Oct 04 2023)
+APSG offers convenient pandas integration via pandas accessors.
+
+See documentation and Pandas interface tutorial for further details.
+
+ * StereoNet tensor method added
+ * Cluster class renamed to ClusterSet
+
+### 1.0.3 (Apr 30 2023)
+ * lambda properties of tensors renamed to S
+ * cursor coordinates in stereonet show lin and fol
+
+### 1.0.1 (Nov 22 2022)
+ * density_lookup method implemented for StereoNet.grid
+ * Stress tensor sigma* properties using inverted order of eigenvalues
+ * render2fig method of StereoNet implemented
+ * vector-like objects are not iterable, so properly render in pandas
+
+## 1.0.0 (Oct 7 2022)
+New major release
+
+APSG has been significantly refactored from version 1.0 and several changes are
+breaking backward compatibility. The main APSG namespace provides often-used
+classes in lowercase names as aliases to `PascalCase` convention used in
+modules to provide a simplified interface for users. The `PascalCase` names of
+classes use longer and plain English names instead acronyms for better
+readability.
+
+See documentation for further details.
+
+### 0.7.3 (Oct 6 2022)
+ * figure window title removed from StereoNet
+ * for future only bugfixes planned, foo further development see versions >=1.0
+
+### 0.7.2 (Oct 6 2022)
+ * bugfix release
+
+### 0.7.1 (Jul 13 2021)
+ * paleomag rs3 input/output improved
+ * Simple SQLAlchemy API to sdb database implemented
+ * StereoNet arc method fixed
+ * StereoNet polygon method added
+
+## 0.7.0 (Feb 3 2021)
+
+* Python 2 support dropped
+* RosePlot added
+* Ortensor has from_pairs method for Lisle tensor for orthogonal data
+* StereoNet scatter method has labels kwarg to show hover annotations
+
+### 0.6.3 (Dec 6 2019)
+
+* Python 2/3 compatibility fix
+
+### 0.6.2 (Dec 6 2019)
+
+* few minor bugs fixed
+* Stereogrid apply_func passes Vec3 instead numpy array
+* Pair H method to get mutual rotation implemented
+* velgrad method of DefGrad accepts steps kwarg
+  to generate list of DefGrad tensors
+* Added Tensor class to work with deformation tensors
+
+### 0.6.1 (Dec 12 2018)
+
+* Stereogrid always use Euclidean norms as weights
+* DefGrad properties e1, e2, e3 (natural principal strains) added
+* DefGrad properties eoct, goct (octahedral strains) added
+* DefGrad from_ratios class method added
+* DefGrad properties k, d, K, D (strain symmetries and intesities) added
+* New class Ellipsoid added to work with ellipsoids
+* FabricPLot renamed to VollmerPlot for consistency
+* RamsayPlot, FlinnPlot and HsuPlot implemented
+* All fabric plots have new path method accepting list of tensors
+
+## 0.6.0 (Nov 7 2018)
+
+* Stress always gives eigenvalues sorted
+* Stress I1, I2, I3 properties for invariants implemented
+* Stress mean_stress property implemented
+* Stress hydrostatic and deviatoric properties implemented
+* precision added to settings to control numerical comparisms
+* figsize added to settings to control figure size across APSG
+* Animation examples fixed
+* rand class method implemented for Fol, Lin, Vec3 and Pair to
+  generate random instance
+* Group to_csv and from_csv improved
+* SDB tags method works properly for multiple tags
+* SDB can modify database metadata
+* QGIS 3 plugin ReadSDB compatibility
+
+### 0.5.4 (Oct 19 2018)
+
+* StereoNet has cbpad keyword for colorbar padding
+* FabricPlot bug introduced in 0.5.2 fixed.
+
+### 0.5.3 (Oct 10 2018)
+
+* Bugfix release
+
+### 0.5.2 (Oct 10 2018)
+
+* Fischer distribution sampling added
+* transform method has norm kwarg to normalize tranformed vectors
+* axisangle property to calculate axis and angle from rotation matrix
+* StereoNet arc method added
+* Vec3 and Group upper and flip properties implemented
+* DefGrad, VelGrad and Stress rotate method accepts also rotation matrix
+* velgrad method added to DefGrad to calculate matrix logarithm
+* StereoGrid has new methods max, min, max_at, min_at
+
+### 0.5.1 (Dec 5 2017)
+
+* Kent distribution sampling added
+* Automatic kernel density estimate for contouring
+* UserWarnings fix
+
+## 0.5.0 (Nov 19 2017)
+
+* bux fix minor release
+
+### 0.4.4 (Mar 25 2017)
+
+* Group method centered improved
+* Group method halfspace added to reorient all vectors towards resultant
+  halfspace
+
+### 0.4.3 (Mar 25 2017)
+
+* Stress tensor with few basic methods implemented
+* StereoGrid keyword argument 'weighted' to control weighting
+* StereoNet kwargs are passed to underlying methods for immediate plots
+* StereoNet tensor method implemented (draw eigenlins or fols based on
+  fol_plot settings)
+* Group totvar property and dot and proj methods implemented
+* Fol and Lin dot method returns absolute value of dot product
+* Vec3 H method to get mutual rotation implemented
+* StereoNet.contourf method draw contour lines as well by default. Option
+  clines controls it.
+* centered bug fixed
+* StereoNet allows simple animations. Add `animate=True` kwarg to plotting
+  method and finally call StereoNet animate method.
+
+### 0.4.1-2 (Mar 4 2017)
+
+* bugfix
+
+## 0.4.0 (Mar 4 2017)
+
+* Density class renamed to StereoGrid
+* Fault sense under rotation fixed
+* FaultSet example provided
+* Angelier-Mechler dihedra method implemented for FaultSet
+* StereoNet accepts StereoGrid and Ortensor as quick plot arguments
+* StereoNet instance has axtitle method to put text below stereonet
+
+### 0.3.7 (Jan 5 2017)
+
+* conda build for all platforms
+* numpy, matplotlib and other helpres imported by default
+* ortensor is normed by default
+* ortensor MADp, MADo, MAD and kind properties added
+
+### 0.3.6 (Jan 3 2017)
+
+* shell script iapsg opens interactive console
+
+### 0.3.5 (Nov 12 2016)
+
+* Simple settings interface implemented in in apsg.core.seetings dictionary.
+  To change settings use:
+  ```
+  from apsg.core import settings
+  setting['name']=value
+  ```
+* `notation` setting with values `dd` or `rhr` control how azimuth argument of
+  Fol is represented.
+* `vec2dd` setting with values `True` or `False` control how `Vec3` is
+  represented.
+* Vec3 could be instantiated by one arument (vector like), 2 arguments
+  (azimuth, inclination) or 3 arguments (azimuth, inclination, magnitude).
+* Group and FaultSet can return array or list of user-defined attributes of
+  all elements
+
+### 0.3.4 (Jun 20 2016)
+
+* RTD fix
+
+### 0.3.3 (Jun 4 2016)
+
+* Added E1,E2,E3 properties and polar decomposition method to DefGrad object
+* StereoNet has vector method to mimics lower and upper hemisphere plotting
+  of Lin and Vec3 objects as used in paleomagnetic plots
+* StereoNet could be initialized with subplots
+* rake method of Fol added to return vector defined by rake
+* Density could be initialized without data for user-defined calculations
+  New method apply_func could be used to calculate density
+* Contour(f) methods accept Density object as argument
+* Added Group class methods to generate Spherical Fibonacci and Golden Section
+  based uniform distributions of Vec3, Lin and Fol
+
+### 0.3.2 (Feb 22 2016)
+
+* FabricPlot - triangular fabric plot added
+* .asvec3 property has .V alias
+* Resultant of Fol and Lin is calculated as vectorial in centered position
+* dv property of Fol added to return dip slip vector
+
+### 0.3.1 (Nov 20 2015)
+
+* SDB class improved. Support basic filtering including tags
+* StereoNet has close method to close figure and new method
+  to re-initialize figure when closed in interactive mode
+* iapsg shell script added to invoke apsg ipython shell
+
+## 0.3.0 (Nov 9 2015)
+
+* Group fancy indexing implemented. Group could be indexed by sequences
+  of indexes like list, tuple or array as well as sliced.
+* Cluster class with hierarchical clustering implemented
+* Group to_file and from_file methods implemented to store data in file
+* Group copy method for shallow copy implemented
+* StereoNet now accept Vec3 and Fault object as well for instant plotting.
+* Ortensor updated with new properties E1,E2,E3 and Vollmer(1989) indexes
+  P,G,R and C. Bug in Woodcocks's shape and strength values fixed.
+* uniform_lin and uniform_fol improved.
+* asvec3 method implemented for Fol and Lin
+* fol_plot property of StereoNet allows choose poles or great circles for
+  immediate plotting
+* bootstrap method of Group provide generator of random resampling with
+  replacements.
+* Group examples method provide few well-known datasets.
+* Matplotlib deprecation warnings are ignored by default
+
+### 0.2.3 (Oct 21 2015)
+
+* New Docstrings format
+* StereoNet.getfols method bug fixed.
+* Shell scripts to run interactive session improved.
+
+### 0.2.2 (Apr 17 2015)
+
+* FaultSet class added. Fault and Hoeppner methods of StereoNet implemented
+* VelGrad and DefGrad classes used for transformations added
+* G class to quickly create groups from strings added.
+
+### 0.2.1 (Dec 9 2014)
+
+* Quick plotting of groups fixed.
+
+## 0.2.0 (Dec 9 2014)
+
+* new StereoNet class for Schmidt projection
+* Quick plot when data are passed as argument `StereoNet` class instantiation
+* mplstereonet dependency depreceated
+* new `Pair` and `Fault` classes to manipulate paired data (full support in future)
+* new `uniform_lin` and `uniform_fol` `Group` methods
+* abs for `Group` implemented to calculate euclidean norms
+* new `Group` method normalized
+* new `Group` properties and methods to calculate spherical statistics
+
+## 0.1.0 (Nov 1 2014)
+
+* First release of APSG

CONTRIBUTING.md

@@ -0,0 +1,91 @@
+# Contributing
+
+Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given. You can contribute in many ways.
+
+## Types of Contributions
+
+### Report Bugs
+
+Report bugs at [https://github.com/ondrolexa/apsg/issues](https://github.com/ondrolexa/apsg/issues).
+
+If you are reporting a bug, please include:
+
+* Your operating system name and version.
+* Any details about your local setup that might be helpful in troubleshooting.
+* Detailed steps to reproduce the bug.
+
+### Fix Bugs
+
+Look through the GitHub issues for bugs. Anything tagged with "bug"
+is open to whoever wants to implement it.
+
+### Implement Features
+
+Look through the GitHub issues for features. Anything tagged with "feature"
+is open to whoever wants to implement it.
+
+### Write Documentation
+
+APSG could always use more documentation, whether as part of the
+official APSG docs, in docstrings, or even on the web in blog posts,
+articles, and such.
+
+### Submit Feedback
+
+The best way to send feedback is to file an issue at [https://github.com/ondrolexa/apsg/issues](https://github.com/ondrolexa/apsg/issues).
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that contributions
+  are welcome :)
+
+## Get Started!
+
+Ready to contribute? Here's how to set up `apsg` for local development.
+
+1. Fork the `apsg` repo on GitHub.
+2. Clone your fork locally with SSH or HTTPS.
+```
+  $ git clone git@github.com:ondrolexa/apsg.git
+  $ git clone https://github.com/ondrolexa/apsg.git
+```
+
+3. Install your local copy and activate the virtual environment via `pipenv`.
+```
+    $ cd apsg/
+    $ pipenv shell
+    $ pipenv install --dev
+```
+4. Create a branch for local development.
+```
+    $ git checkout -b name-of-your-bugfix-or-feature
+```
+6. Now you can make your changes locally.
+
+7. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox.
+```
+    $ flake8 apsg tests
+    $ python setup.py test
+    $ tox
+```
+8. Commit your changes and push your branch to GitHub.
+```
+    $ git add .
+    $ git commit -m "Your detailed description of your changes."
+    $ git push origin name-of-your-bugfix-or-feature
+```
+9. Submit a pull request through the GitHub website.
+
+## Pull Request Guidelines
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests.
+2. If the pull request adds functionality, the docs should be updated. Put
+   your new functionality into a function with a docstring, and add the
+   feature to the list in ``README.md``.
+3. The pull request should work for Python 2.7, 3.5, and 3.6.
+   Check [https://travis-ci.org/ondrolexa/apsg/pull_requests](https://travis-ci.org/ondrolexa/apsg/pull_requests)
+   and make sure that the tests pass for all supported Python versions.

apsg/__init__.py

@@ -0,0 +1,104 @@
+# -*- coding: utf-8 -*-
+
+import importlib.metadata
+from apsg.math import (
+    Vector3 as vec,
+    Vector2 as vec2,
+    Matrix2 as matrix2,
+    Matrix3 as matrix,
+)
+from apsg.config import apsg_conf
+from apsg.feature import (
+    Lineation as lin,
+    Foliation as fol,
+    Pair as pair,
+    Fault as fault,
+    Cone as cone,
+)
+from apsg.feature import (
+    Vector3Set as vecset,
+    Vector2Set as vec2set,
+    LineationSet as linset,
+    FoliationSet as folset,
+    PairSet as pairset,
+    FaultSet as faultset,
+    ConeSet as coneset,
+    EllipseSet as ellipseset,
+    EllipsoidSet as ellipsoidset,
+    OrientationTensor2Set as ortensor2set,
+    OrientationTensor3Set as ortensorset,
+    ClusterSet as cluster,
+)
+from apsg.feature import (
+    DeformationGradient3 as defgrad,
+    VelocityGradient3 as velgrad,
+    Stress3 as stress,
+    Ellipsoid as ellipsoid,
+    OrientationTensor3 as ortensor,
+)
+from apsg.feature import (
+    DeformationGradient2 as defgrad2,
+    VelocityGradient2 as velgrad2,
+    Stress2 as stress2,
+    Ellipse as ellipse,
+    OrientationTensor2 as ortensor2,
+)
+from apsg.feature import G
+from apsg.plotting import (
+    StereoGrid,
+    StereoNet,
+    RosePlot,
+    VollmerPlot,
+    RamsayPlot,
+    FlinnPlot,
+    HsuPlot,
+    quicknet,
+)
+
+__all__ = (
+    "apsg_conf",
+    "vec",
+    "vec2",
+    "matrix",
+    "matrix2",
+    "lin",
+    "fol",
+    "pair",
+    "fault",
+    "cone",
+    "vecset",
+    "vec2set",
+    "linset",
+    "folset",
+    "pairset",
+    "faultset",
+    "coneset",
+    "ellipseset",
+    "ellipsoidset",
+    "ortensor2set",
+    "ortensorset",
+    "cluster",
+    "G",
+    "defgrad",
+    "velgrad",
+    "stress",
+    "ellipsoid",
+    "ortensor",
+    "defgrad2",
+    "velgrad2",
+    "stress2",
+    "ellipse",
+    "ortensor2",
+    "StereoGrid",
+    "StereoNet",
+    "RosePlot",
+    "VollmerPlot",
+    "RamsayPlot",
+    "FlinnPlot",
+    "HsuPlot",
+    "quicknet",
+)
+
+__version__ = importlib.metadata.version("apsg")
+__author__ = "Ondrej Lexa"
+__email__ = "lexa.ondrej@gmail.com"