https://github.com/csatizoltan/cristalx
Identification and analysis of polycrystalline microstructures
https://github.com/csatizoltan/cristalx
analysis mesh-generation microstructure polycrystal python segmentation
Last synced: 6 months ago
JSON representation
Identification and analysis of polycrystalline microstructures
- Host: GitHub
- URL: https://github.com/csatizoltan/cristalx
- Owner: CsatiZoltan
- License: lgpl-3.0
- Created: 2020-04-06T09:08:25.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-23T02:27:02.000Z (10 months ago)
- Last Synced: 2024-07-23T05:11:53.417Z (10 months ago)
- Topics: analysis, mesh-generation, microstructure, polycrystal, python, segmentation
- Language: Jupyter Notebook
- Homepage: https://cristalx.readthedocs.io
- Size: 35.7 MB
- Stars: 6
- Watchers: 4
- Forks: 7
- Open Issues: 64
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# CristalX
[](https://mybinder.org/v2/gh/CsatiZoltan/CristalX/master) [](https://mybinder.org/v2/gh/CsatiZoltan/CristalX/master?filepath=notebooks%2Fexample_application.ipynb) [](https://bettercodehub.com/) [](https://cristalx.readthedocs.io/en/latest/?badge=latest) [](https://gitter.im/CristalX-community/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Identification of individual grains in microscopic images
*CristalX* is a Python package that helps in the analysis of polycrystalline microstructures. Its name originates from the French word 'cristal', corresponding to the English word 'crystal'.
## Features
- Image segmentation to identify the grains in a microstructure
- Analysis tools for the segmented image
- Explicit geometrical representation of the grains
- Interacting with meshes created on the microstructure
- Mapping fields between a mesh and the grid of DIC measurements
- Simulation tools for the inverse problem arising from a combined numerical-experimental method (in progress ...)
- Visualization and data exchange
## Getting help
1. Read the [documentation](https://cristalx.readthedocs.io/).
2. Check the [existing issues](https://github.com/CsatiZoltan/CristalX/issues). They may already provide an answer to you question.
3. Open a [new issue](https://github.com/CsatiZoltan/CristalX/issues/new).
## Contributing
Read the `docs/source/contributing.md` file.
## Citing *CristalX*
We have an article [freely available on SoftwareX](https://doi.org/10.1016/j.softx.2021.100669), showing the background and the design of *CristalX*.
When using *CristalX* in scientific publications, please cite the following paper:
- Csati, Z.; Witz, J.-F.; Magnier, V.; Bartali, A. E.; Limodin, N. & Najjar, D. *CristalX: Facilitating simulations for experimentally obtained grain-based microstructures*. SoftwareX, **2021**, *14*, 100669
BibTeX entry:
```
@Article{Csati2021,
author = {Zoltan Csati and Jean-Fran{\c{c}}ois Witz and Vincent Magnier and Ahmed El Bartali and Nathalie Limodin and Denis Najjar},
journal = {{SoftwareX}},
title = {{CristalX}: {F}acilitating simulations for experimentally obtained grain-based microstructures},
year = {2021},
month = jun,
pages = {100669},
volume = {14},
doi = {10.1016/j.softx.2021.100669},
}
```