🤔 What is APSG?
APSG is the package for structural geologists. It defines several new python classes to easily manage, analyze and visualize orientation structural geology data.
Check CHANGELOG.md for recent updates.
📈 Quick example
from apsg import *
f = folset.random_fisher(position=fol(130, 60))
s = StereoNet()
s.great_circle(f)
s.point(f)
s.contour(f)
s.show()
StereoNet supports both equal-area (Schmidt, default) and equal-angle (Wulff) projections,
lower and upper hemisphere, and rotating the whole net independently of the plotted data --
see the stereonet tutorial in the documentation for examples.
🛠️ Requirements
You need Python 3.12 or later to run APSG. The package requires NumPy, SciPy, Matplotlib, SQLAlchemy, pandas and pygeomag.
🚀 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 in installation, use lab extra:
pip install apsg[lab]
Or install master with:
pip install git+https://github.com/ondrolexa/apsg.git
Alternatively, you can clone the repository and do a local install with uv (recommended for dev):
git clone https://github.com/ondrolexa/apsg.git
cd apsg
uv sync --all-extras --dev
Upgrading via pip
To upgrade an existing version of APSG from PyPI, execute:
pip install apsg --upgrade --no-deps
Comments on system-wide installations on Debian systems
Latest Debian-based systems do not allow installing 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 already have conda or mamba installed, you can create environment with:
conda config --add channels conda-forge
conda create -n apsg python apsg jupyterlab
or using mamba
mamba create -n apsg python apsg jupyterlab
Current release info
| Name | Downloads | Version | Platforms |
|---|---|---|---|
 |
 |
 |
 |
📘 Documentation
You can explore all the features of APSG in documentation.
💻 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.
🪙 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 to 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 the LICENSE file.
1 maintainer
Release files for apsg 2.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| apsg-2.0.0.tar.gz | 184.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| apsg-2.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 335.7 kB
Release files / apsg-2.0.0.tar.gz
| Download URL | apsg-2.0.0.tar.gz |
|---|---|
| Size | 184.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
57426c3871e5d7c25afcc53a100250fd559ad17fc123394df2fe1217dcac8e5b
|
|
BLAKE2b-256 checksum How to use checksums |
15af86d990fe718a8525cf5037d84d512f99ccb233bd7b522bea6564c203d2e9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.17 {"installer":{"name":"uv","version":"0.12.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / apsg-2.0.0-py3-none-any.whl
| Download URL | apsg-2.0.0-py3-none-any.whl |
|---|---|
| Size | 151.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1fdc2e5ee2cf2b61e672426b1b785d94c883527641def7cc0e01799a681bb7d1
|
|
BLAKE2b-256 checksum How to use checksums |
1a271a9e1dd700dff9f4952f5a2bd0465acdd9b757b57fcc2f57c0a752e9fa52
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.17 {"installer":{"name":"uv","version":"0.12.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
