diff --git a/README.md b/README.md index bf12fac..d00f0d3 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # mineralML -[![PyPI](https://badgen.net/pypi/v/mineralML)](https://pypi.org/project/mineralML/) + [![Build Status](https://github.com/SarahShi/mineralML/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/SarahShi/mineralML/actions/workflows/main.yml) -[![Documentation Status](https://readthedocs.org/projects/mineralML/badge/?version=latest)](https://mineralML.readthedocs.io/en/latest/?badge=latest) +[![Documentation Status](https://readthedocs.org/projects/mineralml/badge/?version=latest)](https://mineralml.readthedocs.io/en/latest/?badge=latest) [![codecov](https://codecov.io/gh/SarahShi/mineralML/branch/main/graph/badge.svg)](https://codecov.io/gh/SarahShi/mineralML/branch/main) [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/SarahShi/mineralML/blob/main/mineralML_colab.ipynb) [![Python 3.7](https://img.shields.io/badge/python-3.7+-blue.svg)](https://www.python.org/downloads/release/python-370/) diff --git a/docs/importing_data.rst b/docs/importing_data.rst index a134cd0..5f9f594 100644 --- a/docs/importing_data.rst +++ b/docs/importing_data.rst @@ -27,14 +27,14 @@ The following columns are required for this Chemistry file: * Sample * SiO\ :sub:`2` * TiO\ :sub:`2` -* Al\ :sub:`2` O\ :sub:`3` +* Al\ :sub:`2`O\ :sub:`3` * FeO\ :sub:`t` * MnO * MgO * CaO -* Na\ :sub:`2` O -* K\ :sub:`2` O -* Cr\ :sub:`2` O\ :sub:`3` +* Na\ :sub:`2`O +* K\ :sub:`2`O +* Cr\ :sub:`2`O\ :sub:`3` For example, here a screenshot of a CSV spreadsheet containing the mineral composition data. You can use the ChemistryTemplate.csv from the GitHub repository to create your own. For oxides that were not analyzed or not detected, enter 0 into the cell. diff --git a/docs/introduction.rst b/docs/introduction.rst index bbc53b2..e3eb808 100644 --- a/docs/introduction.rst +++ b/docs/introduction.rst @@ -21,6 +21,7 @@ These folks have been fundamental to the development of ``mineralML``: - `Paula Antoshechkina `_ (California Institute of Technology) - `Kerstin Lehnert `_ (LDEO) + ======== Minerals ======== @@ -52,17 +53,16 @@ Chemistry ``mineralML`` requires inputs of mineral chemistry, in the form of oxides. The machine learning models are trained on 10 oxides: -* Sample -* SiO:sub:`2` +* SiO\ :sub:`2` * TiO\ :sub:`2` -* Al\ :sub:`2` O\ :sub:`3` +* Al\ :sub:`2`O\ :sub:`3` * FeO\ :sub:`t` * MnO * MgO * CaO -* Na\ :sub:`2` O -* K\ :sub:`2` O -* Cr\ :sub:`2` O\ :sub:`3` +* Na\ :sub:`2`O +* K\ :sub:`2`O +* Cr\ :sub:`2`O\ :sub:`3` =====