Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
thegeojesse authored Dec 21, 2022
1 parent ee97a77 commit 1c0ed21
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# What is MinPlot?

Important: Please check the issues tab on the Minplot_V1.0 Github page for a changelog for current bugs and latest fixes. Users can also report bugs here or by emailing the author.

Information: MinPlot is a MATLAB®-based mineral formula recalculation and compositional plotting program for electron microprobe analyses (EPMA). The program offers recalculation and structural formula assignment for 15 different mineral groups: Garnet, pyroxene, olivine, amphibole, feldspar, mica, staurolite, cordierite, chlorite, chloritoid, talc, epidote, titanite, spinel, and sulfides. MinPlot is a fast and easy to use command line program and requires no prior computer programming knowledge. Percent mass fractions of oxides are loaded from datafiles and the user answers simple prompts to select mineral type, normalization scheme, and plotting options. Recalculated mineral formulas are automatically saved as output files and plots may be further manually customized by the user prior to saving.

Loading and Saving Data: MinPlot reads data stored as text (.txt) files. The first line must contain oxide-based headers that are specific to the mineral formula to be recalculated (see Table 1 below). The headers must have capital and lowercase characters as shown in Table 1. For some phases, certain oxides are optional and will be calculated assuming a mass fraction of zero (W_j=0) if they are not included in the file read by MinPlot. MinPlot searches the header row for the column containing the appropriate header for each oxide, as a result the oxide data can be listed in any order in the input file. To start MinPlot, change the MATLAB® directory to the folder containing MinPlot and type the name of the program into the command window and hit ‘return’. When loading the data, the user is prompted to select the file in a pop-up window and, importantly, the file can be located in any folder on the user’s computer or in their network. Following calculation, the user is prompted to save their calculation. If yes, the data is automatically saved as tab delimited text files in the same directory as the source file, allowing for simplified data organization.
Expand Down

0 comments on commit 1c0ed21

Please sign in to comment.