https://github.com/seatonullberg/grains
Metallic and ceramic grain analysis made easy.
Science Score: 10.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
○codemeta.json file
-
○.zenodo.json file
-
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
1 of 3 committers (33.3%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (15.9%) to scientific vocabulary
Keywords
Repository
Metallic and ceramic grain analysis made easy.
Basic Info
Statistics
- Stars: 5
- Watchers: 0
- Forks: 2
- Open Issues: 1
- Releases: 0
Topics
Metadata Files
README.md
grains
Summary
grains is a software package for tech savvy metallurgists and ceramists who
are tired of counting grains by hand. The software reports information related
to the size distribution of grains in a micrograph in both text and graphical
formats. The goal of this project is to automate the process of grain analysis
by applying modern computer vision algorithms.
Installation
grains can be installed easily through the terminal via:
$ pip install grains
To install grains from source for development:
$ git clone https://github.com/seatonullberg/grains.git
$ cd grains
$ pip install -r requirements.txt
$ pip install -e .
Usage
The following example showcases the basic functionality of grains as a software library.
Please note that the image scale in this example is arbitrary as I have not yet found
adequate validation data. Refer to the examples directory for
the simple source code used to generate these results.
If you are more interested in using grains as a CLI, the results of
this example can be replicated with the following command.
$ grains --h=<image height> --w=<image width> <path/to/image>
Input Image
Centroids Image - Default Settings
Area Histogram - Default Settings
Text Summarization - Default Settings
Automatically Generated by grains
Input filename: test_grains.jpg
Number of grains: 40
Grain area mean: 1631.55 um^2
Grain area variance: 1527136.86 um^2
Grain area standard deviation: 1235.77 um^2
Roadmap
~~Grain counter with OpenCV~~
~~Size distribution analysis~~
~~Calculate average grain size in accordance with ASTM E112~~
~~Wrap functionality into a simple CLI~~
~~Package for pip install~~
Validate performance and construct test cases
Make official release on Github
Citation
If you use this software in a publication please cite me using the following BibTeX format.
@Misc{,
author = {R. Seaton Ullberg},
title = {{grains}: Automatic Grain Analysis Tool},
year = {2019--},
url = "https://github.com/seatonullberg/grains",
note = {[Online; accessed <today>]}
}
Owner
- Name: Seaton Ullberg
- Login: seatonullberg
- Kind: user
- Location: Gainesville, FL
- Repositories: 7
- Profile: https://github.com/seatonullberg
Materials Science and Engineering PhD candidate at the University of Florida
GitHub Events
Total
Last Year
Committers
Last synced: over 1 year ago
Top Committers
| Name | Commits | |
|---|---|---|
| Seaton | s****g@g****m | 13 |
| Seaton Ullberg | 3****g | 7 |
| seatonullberg | s****g@u****u | 4 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 8 months ago
All Time
- Total issues: 1
- Total pull requests: 1
- Average time to close issues: N/A
- Average time to close pull requests: less than a minute
- Total issue authors: 1
- Total pull request authors: 1
- Average comments per issue: 0.0
- Average comments per pull request: 0.0
- Merged pull requests: 1
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- seatonullberg (1)
Pull Request Authors
- seatonullberg (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 28 last-month
- Total dependent packages: 0
- Total dependent repositories: 1
- Total versions: 1
- Total maintainers: 1
pypi.org: grains
- Homepage: https://github.com/seatonullberg/grains
- Documentation: https://grains.readthedocs.io/
- License: mit
-
Latest release: 0.1.0
published almost 7 years ago
Rankings
Maintainers (1)
Dependencies
- Click *
- matplotlib *
- numpy *
- opencv-python *
- scipy *
- Click *