search

sarahshi / mineralML

mineralML: Machine Learning for Probabilistic Mineral Classification
https://mineralML.readthedocs.io/
GNU General Public License v3.0
6 stars 1 forks source link

readme

mineralML

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

We present mineralML (mineral classification using Machine Learning) for classifying common igneous minerals based on oxide data collected by EPMA, with functions for calculating stoichiometries and crystallographic sites based on this classification. 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.

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.7 and 3.11 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

Mac/Linux installation will be straightforward. Windows installations will require the additional setup of WSL.