APSG - The package for structural geologists
Project description
: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. ThePascalCase
names of classes use longer and plain English names instead acronyms for better readability.Check documentation for more details.
:hammer_and_wrench: Requirements
You need Python 3.9 or later to run APSG. The package requires NumPy and SciPy, Matplotlib, SciPy, SQLAlchemy and pandas.
: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 |
---|---|---|---|
:blue_book: Documentation
Explore all the features of APSG. You can find detailed documentation here.
:computer: Contributing
Most discussion happens on Github. Feel free to open an issue 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.
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file apsg-1.3.2.tar.gz
.
File metadata
- Download URL: apsg-1.3.2.tar.gz
- Upload date:
- Size: 77.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
3f748ddf0ee7eae026e34e3915fcb2df57bd3f45368d3937b77cc2c80e9d7af6
|
|
MD5 |
b149b719380c64cc70e0b48d35385938
|
|
BLAKE2b-256 |
052577be7f85c1e685bdb8290f3a9ef05ea827e23d1f614abf1ffebecd38b55d
|
Provenance
The following attestation bundles were made for apsg-1.3.2.tar.gz
:
Publisher:
release.yml
on ondrolexa/apsg
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1
-
Predicate type:
https://docs.pypi.org/attestations/publish/v1
-
Subject name:
apsg-1.3.2.tar.gz
-
Subject digest:
3f748ddf0ee7eae026e34e3915fcb2df57bd3f45368d3937b77cc2c80e9d7af6
- Sigstore transparency entry: 176003329
- Sigstore integration time:
-
Permalink:
ondrolexa/apsg@17dd59c3433b219aa6c9e577fc687fa1f168f61b
-
Branch / Tag:
refs/tags/1.3.2
- Owner: https://github.com/ondrolexa
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com
-
Runner Environment:
github-hosted
-
Publication workflow:
release.yml@17dd59c3433b219aa6c9e577fc687fa1f168f61b
-
Trigger Event:
release
-
Statement type:
File details
Details for the file apsg-1.3.2-py3-none-any.whl
.
File metadata
- Download URL: apsg-1.3.2-py3-none-any.whl
- Upload date:
- Size: 83.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
cbeff3d6750842c89c1fe75b4e0abd99c17355f0745153e0c934e75b3f6cd5a0
|
|
MD5 |
9cdb5917a62dbf5d1049fe82d2d2de79
|
|
BLAKE2b-256 |
5679056cffcedd5e373c98d39be1eae83356d5376e0cd70f9e2bd75a7d61b746
|
Provenance
The following attestation bundles were made for apsg-1.3.2-py3-none-any.whl
:
Publisher:
release.yml
on ondrolexa/apsg
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1
-
Predicate type:
https://docs.pypi.org/attestations/publish/v1
-
Subject name:
apsg-1.3.2-py3-none-any.whl
-
Subject digest:
cbeff3d6750842c89c1fe75b4e0abd99c17355f0745153e0c934e75b3f6cd5a0
- Sigstore transparency entry: 176003330
- Sigstore integration time:
-
Permalink:
ondrolexa/apsg@17dd59c3433b219aa6c9e577fc687fa1f168f61b
-
Branch / Tag:
refs/tags/1.3.2
- Owner: https://github.com/ondrolexa
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com
-
Runner Environment:
github-hosted
-
Publication workflow:
release.yml@17dd59c3433b219aa6c9e577fc687fa1f168f61b
-
Trigger Event:
release
-
Statement type: