Skip to main content

mineralML

PyPI Build Status Documentation Status codecov Open In Colab Python 3.8 License: GPL v3 DOI

We present mineralML (mineral classification using Machine Learning) for probabilistic classification of common igneous minerals. mineralML provides functions for calculating stoichiometries and crystallographic sites based on this classification, along with functions for handling mapped EDS data. Utilizing this package allows for the identification of misclassified mineral phases and poor-quality data. We streamline data processing and cleaning to allow for the rapid transition to usable data, improving the utility of data curated in these databases and furthering computing and modeling capabilities.

Documentation

Read the documentation for a run-through of the mineralML code.

Citation

If you use mineralML in your work, please cite this abstract. This package represents a significant time investment. Proper citation helps support continued development and academic recognition.

Shi, S., Wieser, P., Gordon, C., Toth, N., Antoshechkina, P.M., Gleeson, M., Lehnert, K., (2026) mineralML: Leveraging Machine Learning for Probabilistic Mineral Classification in Geochemical Databases", Earth ArXiv. doi:10.31223/X53J2M
@article{Shietal2026,
  doi       = {10.31223/X53J2M},
  url       = {https://doi.org/10.31223/X53J2M},
  year      = {2026},
  author    = {Shi, Sarah C and Wieser, Penny E and Gordon, Charlotte and Toth, Norbert and Antoshechkina, Paula M and Gleeson, Matthew LM and Lehnert, Kerstin},
  title     = {mineralML: Leveraging Machine Learning for Probabilistic Mineral Classification},
  journal   = {Earth ArXiv},
}

Run on the Cloud

If you do not have Python installed locally, run mineralML on Google Colab. The Cloud-based version runs rapidly, with test cases of >10,000 microanalyses classified within 4 seconds.

Run and Install Locally

Obtain a version of Python between 3.9 and 3.14 if you do not already have it installed. mineralML can be installed with one line. Open terminal and type the following:

pip install mineralML

Make sure that you keep up with the latest version of mineralML. To upgrade to the latest version of mineralML, open terminal and type the following:

pip install mineralML --upgrade

Metadata

Release files for mineralML 0.0.3.21

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mineralML 0.0.3.21
File Size Uploaded
mineralml-0.0.3.21.tar.gz 2.1 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for mineralML 0.0.3.21
File Interpreter ABI Platform
mineralml-0.0.3.21-py3-none-any.whl Python 3 none any Details

Total release size: 4.3 MB

Release files / mineralml-0.0.3.21.tar.gz

Download URL mineralml-0.0.3.21.tar.gz
Size 2.1 MB
Tags Source
SHA-256 checksum
How to use checksums
f7858335ea34f0c7391fc2eed68788101ba9706ab6f829e2a947cb294c69b745
BLAKE2b-256 checksum
How to use checksums
749b31d5c9acfd9cfe5ccc2931a5cdeb7e79b0a2e1aa3c12623b416536cde906
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release files / mineralml-0.0.3.21-py3-none-any.whl

Download URL mineralml-0.0.3.21-py3-none-any.whl
Size 2.2 MB
Tags Python 3
SHA-256 checksum
How to use checksums
6cf99f8b87bbd9f140cc710cf7bf8023f9a91d20a5241f069152d7f80ae1d54d
BLAKE2b-256 checksum
How to use checksums
a6a6f9d9fa614b26a0d15c88208581e0274e9434790aa0b68246799c7465a5a1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release history Release notifications | RSS feed

This release

0.0.3.21 This release

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page