Skip to content

Commit

Permalink
Update documentation and README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sarahshi committed Dec 7, 2023
1 parent cbc6360 commit 926ac4b
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 12 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# mineralML
[![PyPI](https://badgen.net/pypi/v/mineralML)](https://pypi.org/project/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/)
Expand Down
8 changes: 4 additions & 4 deletions docs/importing_data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
12 changes: 6 additions & 6 deletions docs/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ These folks have been fundamental to the development of ``mineralML``:
- `Paula Antoshechkina <https://github.com/magmasource>`_ (California Institute of Technology)
- `Kerstin Lehnert <https://lamont.columbia.edu/directory/kerstin-lehnert>`_ (LDEO)


========
Minerals
========
Expand Down Expand Up @@ -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`


=====
Expand Down

0 comments on commit 926ac4b

Please sign in to comment.