apsg 1.2.3__tar.gz → 1.3.1__tar.gz

apsg-1.3.1/.editorconfig

@@ -0,0 +1,21 @@
+# http://editorconfig.org
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+insert_final_newline = true
+charset = utf-8
+end_of_line = lf
+
+[*.bat]
+indent_style = tab
+end_of_line = crlf
+
+[LICENSE]
+insert_final_newline = false
+
+[Makefile]
+indent_style = tab

apsg-1.3.1/.gitattributes

@@ -0,0 +1,25 @@
+# Basic .gitattributes for a python repo.
+
+# Source files
+# ============
+*.pxd		text
+*.py 		text
+*.py3 		text
+*.pyw 		text
+*.pyx  		text
+
+# Binary files
+# ============
+*.db		binary
+*.p 		binary
+*.pkl 		binary
+*.pyc 		binary
+*.pyd		binary
+*.pyo 		binary
+
+# Note: .db, .p, and .pkl files are associated
+# with the python modules ``pickle``, ``dbm.*``,
+# ``shelve``, ``marshal``, ``anydbm``, & ``bsddb``
+# (among others).
+
+.ipynb linguist-generated=true

apsg-1.3.1/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"

apsg-1.3.1/.github/workflows/release.yml

@@ -0,0 +1,32 @@
+name: PyPi Publisher
+
+on:
+    release:
+        types: [published]
+
+jobs:
+    pypi-publisher:
+        runs-on: ubuntu-latest
+        environment:
+            name: pypi
+            url: https://pypi.org/a/apsg
+
+        permissions:
+            id-token: write # IMPORTANT: mandatory for trusted publishing
+
+        steps:
+            - uses: actions/checkout@v4
+              with:
+                  persist-credentials: false
+            - name: Set up Python
+              uses: actions/setup-python@v5
+              with:
+                  python-version: "3.x"
+            - name: Install dependencies
+              run: |
+                  python -m pip install --upgrade pip
+                  pip install build
+            - name: Build package
+              run: python -m build
+            - name: Publish distribution 📦 to PyPI
+              uses: pypa/gh-action-pypi-publish@release/v1

apsg-1.3.1/.github/workflows/testing.yml

@@ -0,0 +1,36 @@
+name: Python testing
+
+on:
+    push:
+        branches:
+            - "**"
+    pull_request:
+
+jobs:
+    build:
+        name: Testing on ${{matrix.os}}
+        runs-on: ${{matrix.os}}
+        strategy:
+            matrix:
+                os: [ubuntu-latest, macos-latest, windows-latest]
+                python-version: ["3.10", "3.11", "3.12"]
+
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v4
+              with:
+                  # setuptools_scm requires a non-shallow clone of the repository
+                  fetch-depth: 0
+
+            - name: Set up Python ${{ matrix.python-version }}
+              uses: actions/setup-python@v5
+              with:
+                  python-version: ${{ matrix.python-version }}
+
+            - name: Install Python package
+              run: |
+                  python -m pip install .[tests]
+
+            - name: Run Python tests
+              run: |
+                  python -m pytest

apsg-1.3.1/.gitignore

@@ -0,0 +1,55 @@
+*.py[cod]
+
+# C extensions
+*.so
+
+# Packages
+*.egg
+*.eggs
+*.egg-info
+dist
+build
+eggs
+parts
+bin
+var
+sdist
+develop-eggs
+.installed.cfg
+lib
+lib64
+
+# Installer logs
+pip-log.txt
+
+# Unit test / coverage reports
+.coverage
+.tox
+nosetests.xml
+htmlcov
+
+# Translations
+*.mo
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
+
+# Complexity
+output/*.html
+output/*/index.html
+
+# Sphinx
+docs/_build
+
+.ipynb_checkpoints/
+docs/notebooks/.ipynb_checkpoints/
+
+# gedit backups
+*~
+
+.pytest_cache/
+
+# virtual environment
+.venv

apsg-1.3.1/.pre-commit-config.yaml

@@ -0,0 +1,40 @@
+repos:
+    - repo: https://github.com/pre-commit/pre-commit-hooks
+      rev: v5.0.0
+      hooks:
+          - id: check-case-conflict
+          - id: check-docstring-first
+          - id: check-illegal-windows-names
+          - id: check-merge-conflict
+          - id: check-toml
+          - id: check-yaml
+          - id: end-of-file-fixer
+          - id: trailing-whitespace
+
+    - repo: https://github.com/psf/black-pre-commit-mirror
+      rev: 24.8.0
+      hooks:
+          - id: black
+            args: [--line-length=88]
+            exclude: ^(.venv/|docs/)
+            types: ["python"]
+
+    - repo: https://github.com/PyCQA/flake8
+      rev: 7.1.1
+      hooks:
+          - id: flake8
+            args:
+                - --max-line-length=88
+                - --ignore=F401,E501,W503,E731,E743,E741,E203
+            exclude: ^(.venv/|docs/)
+            types: ["python"]
+
+    - repo: local
+      hooks:
+          - id: pytest
+            name: pytest
+            entry: ./.venv/bin/pytest
+            language: system
+            types: [python]
+            pass_filenames: false
+            always_run: true

apsg-1.3.1/.readthedocs.yaml

@@ -0,0 +1,16 @@
+version: 2
+
+build:
+    os: ubuntu-22.04
+    tools:
+        python: "3.11"
+
+sphinx:
+    configuration: docs/conf.py
+
+formats: all
+
+python:
+    install:
+        - method: pip
+          path: .[docs]

apsg-1.2.3/HISTORY.md → apsg-1.3.1/CHANGELOG.md

@@ -1,4 +1,14 @@
-# Changes
+# Changelog
+
+### 1.3.1 (Feb 28 2025)
+ * SQLAlchemy interface to sdb updated
+ * matplotlib 3.9 minimum version
+ * collections clipping bug fixed
+
+## 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
@@ -11,7 +21,7 @@
 ### 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)
+## 1.2.0 (May 24 2024)
  * sqlalchemy and pandas added to requirements
  * quicknet fault bug fixed
 
@@ -49,7 +59,7 @@ See documentation and Pandas interface tutorial for further details.
  * 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 
+ * vector-like objects are not iterable, so properly render in pandas
 
 ## 1.0.0 (Oct 7 2022)
 New major release

{apsg-1.2.3 → apsg-1.3.1}/CONTRIBUTING.md

@@ -89,4 +89,3 @@ Before you submit a pull request, check that it meets these guidelines:
 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-1.2.3 → apsg-1.3.1}/LICENSE

@@ -1,6 +1,7 @@
 MIT License
 
-APSG - python package for structural geologists Copyright (c) 2015, Ondrej Lexa
+APSG - The package for structural geologists.
+Copyright (c) 2015-2024, Ondrej Lexa
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

apsg-1.3.1/PKG-INFO

@@ -0,0 +1,187 @@
+Metadata-Version: 2.4
+Name: apsg
+Version: 1.3.1
+Summary: APSG - The package for structural geologists
+Project-URL: Homepage, https://github.com/ondrolexa/apsg
+Project-URL: Documentation, https://apsg.readthedocs.io
+Project-URL: Repository, https://github.com/ondrolexa/apsg.git
+Project-URL: Issues, https://github.com/ondrolexa/apsg/issues
+Project-URL: Changelog, https://github.com/ondrolexa/apsg/blob/master/CHANGELOG.md
+Author-email: Ondrej Lexa <lexa.ondrej@gmail.com>
+Maintainer-email: Ondrej Lexa <lexa.ondrej@gmail.com>
+License: MIT License
+        
+        APSG - The package for structural geologists.
+        Copyright (c) 2015-2024, Ondrej Lexa
+        
+        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.
+License-File: LICENSE
+Keywords: orientation data,stereonet,structural geology
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Requires-Dist: matplotlib>=3.9
+Requires-Dist: numpy
+Requires-Dist: pandas
+Requires-Dist: scipy
+Requires-Dist: sqlalchemy
+Provides-Extra: dev
+Requires-Dist: autodocsumm; extra == 'dev'
+Requires-Dist: black; extra == 'dev'
+Requires-Dist: ipykernel; extra == 'dev'
+Requires-Dist: nbsphinx; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: readthedocs-sphinx-search; extra == 'dev'
+Requires-Dist: sphinx; extra == 'dev'
+Requires-Dist: sphinx-rtd-theme; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: autodocsumm; extra == 'docs'
+Requires-Dist: ipykernel; extra == 'docs'
+Requires-Dist: nbsphinx; extra == 'docs'
+Requires-Dist: readthedocs-sphinx-search; extra == 'docs'
+Requires-Dist: sphinx; extra == 'docs'
+Requires-Dist: sphinx-rtd-theme; extra == 'docs'
+Provides-Extra: extra
+Requires-Dist: jupyterlab; extra == 'extra'
+Requires-Dist: pyqt5; extra == 'extra'
+Provides-Extra: tests
+Requires-Dist: pytest; extra == 'tests'
+Description-Content-Type: text/markdown
+
+<img src="https://ondrolexa.github.io/apsg/apsg_banner.svg" alt="APSG logo" width="300px"/>
+
+[![PyPI - Version](https://img.shields.io/pypi/v/apsg)](https://pypi.org/project/apsg)
+[![Conda](https://img.shields.io/conda/v/conda-forge/apsg)](https://anaconda.org/conda-forge/apsg)
+[![Documentation Status](https://readthedocs.org/projects/apsg/badge/?version=stable)](https://apsg.readthedocs.io/en/stable/?badge=stable)
+[![DOI](https://zenodo.org/badge/24879346.svg)](https://zenodo.org/badge/latestdoi/24879346)
+
+## :thinking: What is APSG?
+
+APSG is the package for structural geologists. It defines several new python classes to easily manage, analyze and visualize orientational structural geology data.
+
+> [!IMPORTANT]
+> 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.
+>
+> Check [documentation](https://apsg.readthedocs.org) for more details.
+
+## :hammer_and_wrench: Requirements
+
+You need Python 3.9 or later to run APSG. The package requires [NumPy](https://numpy.org/) and [SciPy](https://www.scipy.org/),
+[Matplotlib](https://matplotlib.org/), [SciPy](https://scipy.org/), [SQLAlchemy](https://www.sqlalchemy.org/)
+and [pandas](https://pandas.pydata.org/).
+
+## :rocket: How to install
+
+It is strongly suggested to install **apsg** into separate environment. You can create
+Python virtual environment. For Linux and macOS use:
+
+    python -m venv .venv
+    source .venv/bin/activate
+
+for Windows use Command Prompt or PowerShell:
+
+    python -m venv .venv
+    .venv\Scripts\activate
+
+> [!NOTE]
+> On Microsoft Windows, it may be required to set the execution policy in PowerShell for the user.
+> You can do this by issuing the following PowerShell command:
+> ```
+> Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
+> ```
+
+and install latest stable version of **apsg** using pip within the environment:
+
+    pip install apsg
+
+To include jupyterlab and pyqt5 in installation, use `extra` option:
+
+## I'm using conda or mamba to manage environments
+
+    pip install apsg[extra]
+
+or install **master** with:
+
+    pip install git+https://github.com/ondrolexa/apsg.git
+
+Alternatively, you can clone the repository and do a local install (recommended for dev):
+    git clone https://github.com/ondrolexa/apsg.git
+    cd apsg
+    pip install -e .[dev]
+
+#### Upgrading via pip
+
+To upgrade an existing version of APSG from PyPI, execute:
+
+    pip install apsg --upgrade --no-deps
+
+#### Comments on system-wide instalations on Debian systems
+
+Latest Debian-based systems does not allow to install non-debian packages system-wide.
+However, installing all requirements allows to force install APSG system-wide without troubles.
+
+Install requirements using apt:
+
+    sudo apt install python3-numpy python3-matplotlib python3-scipy python3-sqlalchemy python3-pandas
+
+and then install apsg using pip:
+
+    pip install --break-system-packages apsg
+
+### I'm using conda or mamba to manage environments
+
+If you have already have conda or mamba installed, you can create environment with:
+
+    conda config --add channels conda-forge
+    conda create -n apsg python apsg jupyterlab pyqt
+
+or using mamba
+
+    mamba create -n apsg python apsg jupyterlab pyqt
+
+#### Current release info
+
+| Name | Downloads | Version | Platforms |
+| --- | --- | --- | --- |
+| [![Conda Recipe](https://img.shields.io/badge/recipe-apsg-green.svg)](https://anaconda.org/conda-forge/apsg) | [![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/apsg.svg)](https://anaconda.org/conda-forge/apsg) | [![Conda Version](https://img.shields.io/conda/vn/conda-forge/apsg.svg)](https://anaconda.org/conda-forge/apsg) | [![Conda Platforms](https://img.shields.io/conda/pn/conda-forge/apsg.svg)](https://anaconda.org/conda-forge/apsg) |
+
+## :blue_book: Documentation
+
+Explore all the features of APSG. You can find detailed documentation [here](https://apsg.readthedocs.org).
+
+## :computer: Contributing
+
+Most discussion happens on [Github](https://github.com/ondrolexa/apsg). Feel free to open [an issue](https://github.com/ondrolexa/apsg/issues/new) or comment on any open issue or pull request. Check ``CONTRIBUTING.md`` for more details.
+
+## :coin: Donate
+
+APSG is an open-source project, available for you for free. It took a lot of time and resources to build this software. If you find this software useful and want to support its future development please consider donating me.
+
+[![Donate via PayPal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=QTYZWVUNDUAH8&item_name=APSG+development+donation&currency_code=EUR&source=url)
+
+## License
+
+APSG is free software: you can redistribute it and/or modify it under the terms of the MIT License. A copy of this license is provided in ``LICENSE`` file.

apsg-1.3.1/README.md

@@ -0,0 +1,118 @@
+<img src="https://ondrolexa.github.io/apsg/apsg_banner.svg" alt="APSG logo" width="300px"/>
+
+[![PyPI - Version](https://img.shields.io/pypi/v/apsg)](https://pypi.org/project/apsg)
+[![Conda](https://img.shields.io/conda/v/conda-forge/apsg)](https://anaconda.org/conda-forge/apsg)
+[![Documentation Status](https://readthedocs.org/projects/apsg/badge/?version=stable)](https://apsg.readthedocs.io/en/stable/?badge=stable)
+[![DOI](https://zenodo.org/badge/24879346.svg)](https://zenodo.org/badge/latestdoi/24879346)
+
+## :thinking: What is APSG?
+
+APSG is the package for structural geologists. It defines several new python classes to easily manage, analyze and visualize orientational structural geology data.
+
+> [!IMPORTANT]
+> 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.
+>
+> Check [documentation](https://apsg.readthedocs.org) for more details.
+
+## :hammer_and_wrench: Requirements
+
+You need Python 3.9 or later to run APSG. The package requires [NumPy](https://numpy.org/) and [SciPy](https://www.scipy.org/),
+[Matplotlib](https://matplotlib.org/), [SciPy](https://scipy.org/), [SQLAlchemy](https://www.sqlalchemy.org/)
+and [pandas](https://pandas.pydata.org/).
+
+## :rocket: How to install
+
+It is strongly suggested to install **apsg** into separate environment. You can create
+Python virtual environment. For Linux and macOS use:
+
+    python -m venv .venv
+    source .venv/bin/activate
+
+for Windows use Command Prompt or PowerShell:
+
+    python -m venv .venv
+    .venv\Scripts\activate
+
+> [!NOTE]
+> On Microsoft Windows, it may be required to set the execution policy in PowerShell for the user.
+> You can do this by issuing the following PowerShell command:
+> ```
+> Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
+> ```
+
+and install latest stable version of **apsg** using pip within the environment:
+
+    pip install apsg
+
+To include jupyterlab and pyqt5 in installation, use `extra` option:
+
+## I'm using conda or mamba to manage environments
+
+    pip install apsg[extra]
+
+or install **master** with:
+
+    pip install git+https://github.com/ondrolexa/apsg.git
+
+Alternatively, you can clone the repository and do a local install (recommended for dev):
+    git clone https://github.com/ondrolexa/apsg.git
+    cd apsg
+    pip install -e .[dev]
+
+#### Upgrading via pip
+
+To upgrade an existing version of APSG from PyPI, execute:
+
+    pip install apsg --upgrade --no-deps
+
+#### Comments on system-wide instalations on Debian systems
+
+Latest Debian-based systems does not allow to install non-debian packages system-wide.
+However, installing all requirements allows to force install APSG system-wide without troubles.
+
+Install requirements using apt:
+
+    sudo apt install python3-numpy python3-matplotlib python3-scipy python3-sqlalchemy python3-pandas
+
+and then install apsg using pip:
+
+    pip install --break-system-packages apsg
+
+### I'm using conda or mamba to manage environments
+
+If you have already have conda or mamba installed, you can create environment with:
+
+    conda config --add channels conda-forge
+    conda create -n apsg python apsg jupyterlab pyqt
+
+or using mamba
+
+    mamba create -n apsg python apsg jupyterlab pyqt
+
+#### Current release info
+
+| Name | Downloads | Version | Platforms |
+| --- | --- | --- | --- |
+| [![Conda Recipe](https://img.shields.io/badge/recipe-apsg-green.svg)](https://anaconda.org/conda-forge/apsg) | [![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/apsg.svg)](https://anaconda.org/conda-forge/apsg) | [![Conda Version](https://img.shields.io/conda/vn/conda-forge/apsg.svg)](https://anaconda.org/conda-forge/apsg) | [![Conda Platforms](https://img.shields.io/conda/pn/conda-forge/apsg.svg)](https://anaconda.org/conda-forge/apsg) |
+
+## :blue_book: Documentation
+
+Explore all the features of APSG. You can find detailed documentation [here](https://apsg.readthedocs.org).
+
+## :computer: Contributing
+
+Most discussion happens on [Github](https://github.com/ondrolexa/apsg). Feel free to open [an issue](https://github.com/ondrolexa/apsg/issues/new) or comment on any open issue or pull request. Check ``CONTRIBUTING.md`` for more details.
+
+## :coin: Donate
+
+APSG is an open-source project, available for you for free. It took a lot of time and resources to build this software. If you find this software useful and want to support its future development please consider donating me.
+
+[![Donate via PayPal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=QTYZWVUNDUAH8&item_name=APSG+development+donation&currency_code=EUR&source=url)
+
+## License
+
+APSG is free software: you can redistribute it and/or modify it under the terms of the MIT License. A copy of this license is provided in ``LICENSE`` file.