apsg 1.3.0__tar.gz → 1.3.2__tar.gz

apsg-1.3.2/LICENSE

@@ -0,0 +1,22 @@
+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.

apsg-1.3.2/PKG-INFO

@@ -0,0 +1,188 @@
+Metadata-Version: 2.2
+Name: apsg
+Version: 1.3.2
+Summary: APSG - The package for structural geologists
+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.
+        
+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
+Keywords: structural geology,stereonet,orientation data
+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
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: matplotlib>=3.9
+Requires-Dist: scipy
+Requires-Dist: sqlalchemy
+Requires-Dist: pandas
+Provides-Extra: extra
+Requires-Dist: jupyterlab; extra == "extra"
+Requires-Dist: pyqt5; extra == "extra"
+Provides-Extra: tests
+Requires-Dist: pytest; extra == "tests"
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx_rtd_theme; extra == "docs"
+Requires-Dist: readthedocs-sphinx-search; extra == "docs"
+Requires-Dist: ipykernel; extra == "docs"
+Requires-Dist: nbsphinx; extra == "docs"
+Requires-Dist: autodocsumm; extra == "docs"
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: sphinx; extra == "dev"
+Requires-Dist: sphinx_rtd_theme; extra == "dev"
+Requires-Dist: readthedocs-sphinx-search; extra == "dev"
+Requires-Dist: ipykernel; extra == "dev"
+Requires-Dist: nbsphinx; extra == "dev"
+Requires-Dist: autodocsumm; extra == "dev"
+
+<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.0 → apsg-1.3.2}/README.md

@@ -24,31 +24,50 @@ You need Python 3.9 or later to run APSG. The package requires [NumPy](https://n
 [Matplotlib](https://matplotlib.org/), [SciPy](https://scipy.org/), [SQLAlchemy](https://www.sqlalchemy.org/)
 and [pandas](https://pandas.pydata.org/).
 
-## :rocket: Quick start
+## :rocket: How to install
 
-Install the **latest stable** version of APSG from PyPI:
-```bash
-pip install apsg
-```
+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:
-```bash
-pip install git+https://github.com/ondrolexa/apsg.git
-```
 
-Alternatively, you can cloce the repository and do a local install (recommended for dev):
-```bash
-git clone https://github.com/ondrolexa/apsg.git
-cd apsg
-pip install -e ."
-```
+    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:
-```bash
-pip install apsg --upgrade --no-deps
-```
+
+    pip install apsg --upgrade --no-deps
 
 #### Comments on system-wide instalations on Debian systems
 
@@ -56,36 +75,23 @@ Latest Debian-based systems does not allow to install non-debian packages system
 However, installing all requirements allows to force install APSG system-wide without troubles.
 
 Install requirements using apt:
-```bash
-sudo apt install python3-numpy python3-matplotlib python3-scipy python3-sqlalchemy python3-pandas
-```
 
-and then install apsg using pip:
-```bash
-pip install --break-system-packages apsg
-```
+    sudo apt install python3-numpy python3-matplotlib python3-scipy python3-sqlalchemy python3-pandas
 
-### Conda/Mamba
+and then install apsg using pip:
 
-The APSG package is also available on `conda-forge` channel. Installing `apsg`
-from the `conda-forge` channel can be achieved by adding `conda-forge` to your
-channels:
+    pip install --break-system-packages apsg
 
-```bash
-conda config --add channels conda-forge
-```
+### I'm using conda or mamba to manage environments
 
-Once the `conda-forge` channel has been enabled, `apsg` can be installed with:
+If you have already have conda or mamba installed, you can create environment with:
 
-```bash
-conda install apsg
-```
+    conda config --add channels conda-forge
+    conda create -n apsg python apsg jupyterlab pyqt
 
-It is possible to list all of the versions of `apsg` available on your platform with:
+or using mamba
 
-```bash
-conda search apsg --channel conda-forge
-```
+    mamba create -n apsg python apsg jupyterlab pyqt
 
 #### Current release info
 

apsg-1.3.2/pyproject.toml

@@ -0,0 +1,68 @@
+[project]
+name = "apsg"
+dynamic = ["version"]
+description = "APSG - The package for structural geologists"
+readme = "README.md"
+requires-python = ">=3.10"
+license = { file = "LICENSE" }
+keywords = ["structural geology", "stereonet", "orientation data"]
+authors = [{ name = "Ondrej Lexa", email = "lexa.ondrej@gmail.com" }]
+maintainers = [{ name = "Ondrej Lexa", email = "lexa.ondrej@gmail.com" }]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+]
+dependencies = ["numpy", "matplotlib>=3.9", "scipy", "sqlalchemy", "pandas"]
+
+[project.optional-dependencies]
+extra = ["jupyterlab", "pyqt5"]
+tests = ["pytest"]
+docs = [
+    "sphinx",
+    "sphinx_rtd_theme",
+    "readthedocs-sphinx-search",
+    "ipykernel",
+    "nbsphinx",
+    "autodocsumm",
+]
+dev = [
+    "pytest",
+    "black",
+    "sphinx",
+    "sphinx_rtd_theme",
+    "readthedocs-sphinx-search",
+    "ipykernel",
+    "nbsphinx",
+    "autodocsumm",
+]
+
+[project.urls]
+Homepage = "https://github.com/ondrolexa/apsg"
+Documentation = "https://apsg.readthedocs.io"
+Repository = "https://github.com/ondrolexa/apsg.git"
+Issues = "https://github.com/ondrolexa/apsg/issues"
+Changelog = "https://github.com/ondrolexa/apsg/blob/master/CHANGELOG.md"
+
+[project.scripts]
+iapsg = "apsg.shell:main"
+
+[build-system]
+requires = ["setuptools >= 61.0"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.dynamic]
+version = { attr = "apsg.__version__" }
+
+[tool.black]
+line-length = 88
+exclude = '''
+/(
+  \.toml
+  |\.sh
+  |\.git
+  |\.ini
+)/
+'''

apsg-1.3.2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

{apsg-1.3.0 → apsg-1.3.2}/src/apsg/__init__.py

@@ -1,6 +1,5 @@
 # -*- coding: utf-8 -*-
 
-import importlib.metadata
 from apsg.math import (
     Vector3 as vec,
     Vector2 as vec2,
@@ -99,6 +98,6 @@ __all__ = (
     "quicknet",
 )
 
-__version__ = importlib.metadata.version("apsg")
+__version__ = "1.3.2"
 __author__ = "Ondrej Lexa"
 __email__ = "lexa.ondrej@gmail.com"