Skip to main content

Tools for geochemical data analysis.

Project description

pyrolite

pyrolite Logo

pyrolite Documentation pyOpenSci DOI License: CSIRO Modified BSD/MIT License Try pyrolite on Binder Chat on Gitter

pyrolite is a set of tools for making the most of your geochemical data.

The python package includes functions to work with compositional data, to transform geochemical variables (e.g. elements to oxides), functions for common plotting tasks (e.g. spiderplots, ternary diagrams, bivariate and ternary density diagrams), and numerous auxiliary utilities.

pyrolite is principally developed for use in geochemical research, but is also well suited to being incorporated into university-level geochemistry and petrology classes which wish to include a little Python. The documentation is continually evolving, and more examples and tutorials will gradually be added (feel free to request features or examples; see Contributing below).

Install

PyPI Compatible Python Versions pyrolite downloads

pip install pyrolite

If you want the most up to date development version, you can instead install directly from the GitHub repo. Note that breaking changes occur on this branch, and is not guaranteed to remain stable (check the Development and Build Status below). If you still want to try out the most recent bugfixes and yet-to-be-released features, you can install this version with:

pip install git+git://github.com/morganjwilliams/pyrolite.git@develop#egg=pyrolite

For more information, see the documentation's installation page, and the Getting Started Guide.

Examples

Check out the documentation for galleries of examples and tutorials. The corresponding sources of these examples exist as marked-up .py files in this repository (which get converted to Jupyter notebooks on ReadTheDocs); you can find them under the folders docs/source/gallery/examples and docs/source/gallery/tutorials.

Contributing

The long-term aim of this project is to be designed, built and supported by (and for) the geochemistry community. The project welcomes feature requests, bug reports and contributions to the code base, documentation and test suite. We're happy to help onboard new contributors and walk you through the process. Check out the Issues Board to get an idea of some of the some of the currently identified bugs and things we're looking to work on. For more information, see the documentation, particularly the Contributing page and Code of Conduct.

For a list of people who have helped build and improve pyrolite, check out the Contributors page.

If you'd like an idea of where the project might be heading in the near future, have a look at the current roadmap.

Citation

DOI Archive

If you use pyrolite extensively for your research, citation of the software would be particularly appreciated. It helps quantify the impact of the project (assisting those contributing through paid and volunteer work), and is one way to get the message out and help build the pyrolite community. For information on citing pyrolite, see the relevant docs page.

Development & Build Status

Formatted with Black Code Quality

main develop
Unit Tests on main Unit Tests on Develop
Coverage Status Coverage Status

Maintainer: Morgan Williams (morgan.williams at csiro.au)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyrolite-0.3.6.tar.gz (394.0 kB view details)

Uploaded Source

Built Distribution

pyrolite-0.3.6-py3-none-any.whl (460.9 kB view details)

Uploaded Python 3

File details

Details for the file pyrolite-0.3.6.tar.gz.

File metadata

  • Download URL: pyrolite-0.3.6.tar.gz
  • Upload date:
  • Size: 394.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.10

File hashes

Hashes for pyrolite-0.3.6.tar.gz
Algorithm Hash digest
SHA256 c583fdbddcaaeded00dd59354373380c7b1887095330426cf4c5dba722180bc0
MD5 805b8aad1f19afbf614863e08c67a476
BLAKE2b-256 20c40ef1be5a7ced27e1948127960832462a394fa428f8533019c49d21acac7c

See more details on using hashes here.

File details

Details for the file pyrolite-0.3.6-py3-none-any.whl.

File metadata

  • Download URL: pyrolite-0.3.6-py3-none-any.whl
  • Upload date:
  • Size: 460.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.10

File hashes

Hashes for pyrolite-0.3.6-py3-none-any.whl
Algorithm Hash digest
SHA256 876377822045dd010981f1ec55eada25236ff630145034e584fdda218031a027
MD5 6ee64469903c5402ea897634af592a36
BLAKE2b-256 20e6742e2b4e525f04040c402588efd212ac8e19a6cce7466361be79134749b7

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page