Skip to content

Commit

Permalink
update website
Browse files Browse the repository at this point in the history
  • Loading branch information
marcoalopez committed Feb 7, 2024
1 parent d117844 commit 606d843
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 22 deletions.
40 changes: 20 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

_Maintained by [Marco A. Lopez-Sanchez](https://marcoalopez.github.io/) - This website was last modified: 2024/02/07_

[GrainSizeTools](https://doi.org/10.21105/joss.00863) is a free, open-source, cross-platform script written in [Python](https://www.python.org/) that provides tools for (1) describing and visualizing grain size populations, (2) estimating differential stress for different mineral phases via paleopizometers and (3) apply stereology methods to approximate the actual distribution (3D) of grain size from sections. The script **does not require previous experience with the Python programming language** (see the documentation below and [FAQ](https://github.com/marcoalopez/GrainSizeTools/blob/master/DOCS/FAQ.md)). For users with coding skills, the script is organized in a modular (functional) way facilitating the reuse and code extension.
[GrainSizeTools](https://doi.org/10.21105/joss.00863) is a free, open-source, cross-platform script written in [Python](https://www.python.org/) that provides tools for (1) describing and visualizing grain size populations, (2) estimating differential stress for different mineral phases using paleopizometers and (3) applying stereological methods to approximate the true grain size distribution from 2D sections. The script **does not require any previous experience with the Python programming language** (see the documentation below and [FAQ](https://github.com/marcoalopez/GrainSizeTools/blob/master/DOCS/FAQ.md)). For users with programming skills, the script is organized in a modular (functional) way to facilitate reuse and code extension.

**Latest release: v3.0.2**
**Date: 2020/12/31**
Expand All @@ -11,28 +11,28 @@ See notes at https://github.com/marcoalopez/GrainSizeTools/releases/tag/v3.0.2

## Features at a glance

- Import and manipulate tabular-like datasets including txt, csv, or excel formats.
- Import and manipulate tabular data sets including text, CSV, or Excel formats.

- Full automatic descriptive statistics of grain size populations including:
- Fully automated descriptive statistics of grain size populations including:

- Several averages (arithmetic and geometric means, median, and frequency peak ("mode") via Gaussian Kernel Density Estimator)
- Multiple averages (arithmetic and geometric means, median, and frequency peak ("mode") via Gaussian Kernel Density Estimator)
- Estimation of robust confidence intervals (including some specific methods for lognormal populations such as the modified Cox or the GCI method)
- Measures of dispersion and shape of the population
- Normality and lognormality test
- Measures of dispersion and population shape
- Normality and lognormality tests

- Estimate differential stress using paleopiezometers. It includes multiple piezometric relations for quartz, olivine, calcite, and feldspar (others planned!)
- Estimation of differential stress using palaeopiezometers. Includes several piezometric relations for quartz, olivine, calcite and feldspar (more to come!)

- Ready-to-publish plots in bitmap or vector format (see screenshots below), including:

- Histograms and kernel density estimates
- Area- or volume-weighted plots
- Area or volume-weighted plots
- Normalized plots
- Quantile-quantile plots, and more

- Stereology methods (approximate the actual 3D grain size distribution from data collected in plane sections):
- Stereology methods (approximating the true 3D grain size distribution from data collected in flat sections):

- Saltykov method
- Two-step method (lognormal fitting, shape characterization)
- Two-step method (log-normal fitting, shape characterization)

## Download

Expand All @@ -49,10 +49,10 @@ https://sourceforge.net/projects/grainsizetools/
* [Getting started: first steps using the GrainSizeTools script](https://github.com/marcoalopez/GrainSizeTools/blob/master/DOCS/_first_steps.md)
* [Describing the population of grain sizes](https://github.com/marcoalopez/GrainSizeTools/blob/master/DOCS/_describe.md)
* [The plot module: visualizing grain size distributions](https://github.com/marcoalopez/GrainSizeTools/blob/master/DOCS/_Plot_module.md)
* [The stereology module](https://github.com/marcoalopez/GrainSizeTools/blob/master/DOCS/stereology_module.md) 🚨 **Recently updated!**
* [The paleopiezometry module](https://github.com/marcoalopez/GrainSizeTools/blob/master/DOCS/_Paleopizometry.md)
* [The stereology module](https://github.com/marcoalopez/GrainSizeTools/blob/master/DOCS/stereology_module.md)

***Others***
**Supplementary material**

* [How to measure the areas of the grain profiles with ImageJ](https://github.com/marcoalopez/GrainSizeTools/blob/master/DOCS/imageJ_tutorial.md)

Expand All @@ -62,11 +62,11 @@ https://sourceforge.net/projects/grainsizetools/

## Citation guidelines

If you have utilized the script, I kindly request that you consider citing the following paper:
If you have used the script, please consider citing the following paper:

> Lopez-Sanchez, Marco A. (2018). GrainSizeTools: a Python script for grain size analysis and paleopiezometry based on grain size. *Journal of Open Source Software*, 3(30), 863, https://doi.org/10.21105/joss.00863
By acknowledging this paper, you provide proper credit to the author and acknowledge his work.
By citing this paper, you are giving proper credit to the author and acknowledging his work.

## License

Expand All @@ -76,20 +76,20 @@ The documentation of GrainSizeTools script is licensed under a [Creative Commons

## Community guidelines

The GitHub website hosting the project provides several options (you will need a GitHub account, its free!):
The GitHub site where the project is hosted offers several options (you'll need a GitHub account, it's free!)::

- Open a [discussion](https://github.com/marcoalopez/GrainSizeTools/discussions): This is a place to:
- Ask questions you are wondering about.
- Share ideas.
- Engage with the developers (still just me).
- Open and [issue](https://github.com/marcoalopez/GrainSizeTools/issues): This is a place to track bugs or requests for specific features on the scripts.
- Create a [pull request](https://github.com/marcoalopez/GrainSizeTools/pulls): You modified, corrected or added a feature to one of the notebooks and send it for one of the developers to review it and add it to the main page.
- Requests for specific features or share ideas.
- Interact with the developers.
- Open an [issue](https://github.com/marcoalopez/GrainSizeTools/issues): This is a place to report or track bugs.
- Make a [pull request](https://github.com/marcoalopez/GrainSizeTools/pulls): You have modified, corrected or added a feature to one of the notebooks and send it to one of the developers to review it and add it to the main page.

---
*Copyright © 2017-2024 Marco A. Lopez-Sanchez*

> [!WARNING]
> Information presented on this website and the documentation of the script is provided without any express or implied warranty and may include technical inaccuracies or typing errors; the author reserve the right to modify or enhance the content of this website as well as the documentation of the script at any time without previous notice. This webpage and the documentation is not liable for the content of external links.
> The information on this website and in the script documentation is provided without any warranty of any kind, either expressed or implied, and may include technical inaccuracies or typographical errors; the author reserves the right to make changes or improvements to the content of this website and the script documentation at any time without notice. This website and its documentation are not responsible for the content of external links.
*Hosted on GitHub Pages — This website was created with [Typora](https://typora.io/)*

Expand Down
Loading

0 comments on commit 606d843

Please sign in to comment.