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 for more details.
You need Python 3.9 or later to run APSG. The package requires NumPy and SciPy, Matplotlib, SciPy, SQLAlchemy and pandas.
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:
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]
To upgrade an existing version of APSG from PyPI, execute:
pip install apsg --upgrade --no-deps
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
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
Name | Downloads | Version | Platforms |
---|---|---|---|
Explore all the features of APSG. You can find detailed documentation here.
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.
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.
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.