Commit 3ffa898c authored by Maurine Montagnat's avatar Maurine Montagnat
Browse files

english corrections

parent 08825b2a
Pipeline #75521 canceled with stage
......@@ -4,11 +4,11 @@
The aim of this toolbox is to provide tools to perform data analyses on orientation maps.
An orientation map is a 2d image where a 3d unit vector is assign at each pixel.
Those analyses are build around the [`xarray`](http://xarray.pydata.org/en/stable/) library and two accessors [`xarrayaita`](https://gricad-gitlab.univ-grenoble-alpes.fr/mecaiceige/tools/lib_python/xarray_aita) and [`xarrayuvecs`](https://gricad-gitlab.univ-grenoble-alpes.fr/mecaiceige/tools/lib_python/xarray_uvecs).
These analyses are built around the [`xarray`](http://xarray.pydata.org/en/stable/) library and two accessors [`xarrayaita`](https://gricad-gitlab.univ-grenoble-alpes.fr/mecaiceige/tools/lib_python/xarray_aita) and [`xarrayuvecs`](https://gricad-gitlab.univ-grenoble-alpes.fr/mecaiceige/tools/lib_python/xarray_uvecs).
All this documentation is built from jupyter-notebook and can be run using MyBinder by clicking on the "launch button" on the top right of this page (the little rocket 🚀).
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/git/https%3A%2F%2Fgricad-gitlab.univ-grenoble-alpes.fr%2Fmecaiceige%2Ftools%2Fdocumentations%2FAITA-book/main?filepath=docs)
......@@ -16,11 +16,11 @@
## Tutorials
- [Quick start](Quick_start.ipynb) : Short tutorial to plot colormap and pole figure from your dataset.
- [Crop data](Crop_data.ipynb) : Crop your data.
- [Misorientation profile](mis_profile.ipynb) : Plot misorientation profile along a line.
- [Mean grain](mean_grain.ipynb) : Compute the average orientation per grain.
- [Mean grain](mean_grain.ipynb) : Compute the average orientation per grain. Requires the grain boundary segmentation data.
- [Misorientation angle distribution](mis_angle_dist.ipynb) : Compute the misorientation angle distribution.
- [Grain boundaries segmentation](segmentation.ipynb) : Perform grain boundary segmentation.
%% Cell type:markdown id: tags:
......@@ -51,12 +51,12 @@
`git clone https://gricad-gitlab.univ-grenoble-alpes.fr/mecaiceige/tools/documentations/AITA-book`
%% Cell type:markdown id: tags:
## Contribute
You are welcome to contribute to the project. Here are some ways to contribute to it :
You are welcome to contribute to the project. To do so you can:
1. Submit commit to fix bug or add new functionalities.
2. Report [issues](https://gricad-gitlab.univ-grenoble-alpes.fr/mecaiceige/tools/documentations/AITA-book/-/issues) that you have found using those tools.
3. Talk about the tools around you if you find it interesting and/or put a star on it.
2. Report [issues](https://gricad-gitlab.univ-grenoble-alpes.fr/mecaiceige/tools/documentations/AITA-book/-/issues) that you have found using the tools.
3. Talk about these tools around you if you find it interesting and/or put a star on it.
Feel free to [contact me](mailto:thomas.chauve@univ-grenoble-alpes.fr) if you like to discuss about it.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment