pyrolite 0.3.7

Tools for geochemical data analysis.

pyrolite

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

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 setup an enviroinment using uv with:

git clone git://github.com/morganjwilliams/pyrolite.git@develop
git checkout develop
uv sync --extra dev

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

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. A CITATION.cff file is also provided for reference.

Development & Build Status

main	develop

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