gcalinak / apsg Goto Github PK

APSG is package for structural geologists. It defines several new python classes to easily manage, analyze and visualize orientational structural geology data.

You need Python 3.6 or later to run APSG. The package requires NumPy and SciPy, and the plotting routines require Matplotlib.

APSG can be installed using pip:

pip install apsg

If you want tu run the latest version of code, you can install it from git:

pip install git+git://github.com/ondrolexa/apsg.git

Alternatively, you can download the package manually from the GitHub repository https://github.com/ondrolexa/apsg, unzip it, navigate into the package, and use the command:

python setup.py install

To upgrade an existing version of APSG from PyPI, execute

pip install apsg --upgrade --no-deps

Please note that the dependencies (Matplotlib, NumPy and SciPy) will also be upgraded if you omit the --no-deps flag; use the --no-deps ("no dependencies") flag if you don't want this.

In rare cases, users reported problems on certain systems with the default pip installation command, which installs APSG from the binary distribution ("wheels") on PyPI. If you should encounter similar problems, you could try to install APSG from the source distribution instead via

pip install --no-binary :all: apsg

Also, I would appreciate it if you could report any issues that occur when using pip install apsg in hope that we can fix these in future releases.

The APSG package is also available through conda-forge.

Name	Downloads	Version	Platforms

Installing apsg from the conda-forge channel can be achieved by adding conda-forge to your channels with:

conda config --add channels conda-forge

Once the conda-forge channel has been enabled, apsg can be installed with:

conda install apsg

It is possible to list all of the versions of apsg available on your platform with:

conda search apsg --channel conda-forge

You can see APSG in action in accompanied Jupyter notebook http://nbviewer.jupyter.org/github/ondrolexa/apsg/blob/master/examples/apsg_tutorial.ipynb

And for fun check how simply you can animate stereonets http://nbviewer.jupyter.org/github/ondrolexa/apsg/blob/master/examples/animation_example.ipynb

Explore the full 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.