Improve Documentation

[ralfHielscher]

Lets try to restructure the documentation a bit. The following list is preliminary and will be changed according to discussion and work progress. Everybody is invited to contribute.

1. Tutorials

   • [ ] EBSD
   • [ ] Grains
   • [ ] Pole Figures
   • [ ] ODFs
   • [ ] Import from VPSC - should only explain how to import data from VPSC simulations

2. General Concepts

   • [ ] lists and indexing
   • [ ] properties
   • [ ] *vectors
   • [ ] *rotations
   • [ ] spherical functions,
   • [ ] density estimation
   • [ ] clustering

3. Plotting

   • [ ] axes alignment
   • [ ] multiplot
   • [ ] annotations
   • [ ] export
   • [ ] spherical projections
   • [ ] legends
   • [ ] colormaps

4. Crystal Geometry

   • [ ] *crystal symmetries
   • [ ] *crystal shapes
   • [ ] *Miller
   • [ ] *fundamental region / Moraviec cell
   • [ ] *fundamental sector

5. Orientations

   • [ ] definition as coordinate transform
   • [ ] pole figures
   • [ ] inverse pole figures
   • [ ] orientation visualization - 3d
   • [ ] orientation visualization - sections
   • [ ] Eulern angle conventions
   • [ ] MTEX vs. Bunge Convention
   • [ ] Specimen symmetry
   • [ ] Grids of orientations

6. misorientations

   • [ ] misorientations
   • [ ] twinning
   • [ ] misorientation distribution function,
   • [ ] axis distribution function
   • [ ] angle distribution function

7. Phase transitions

   • [ ] parent/child variants
   • [ ] transformation texture
   • [ ] parent grain reconstruction
   • [ ] grain merging

8. ODF Analysis

   • [ ] ODF modeling
   • [ ] Detection of Sample Symmetry
   • [ ] Visualization - overview
   • [ ] Euler angle sections
   • [ ] sigma sections
   • [ ] ODF characteristics
   • [ ] unimodal ODFs
   • [ ] fibre ODFs
   • [ ] Harmonic ODFs
   • [ ] discretization error
   • [ ] Import/Export
   • [ ] density estimation
   • [ ] Bingham ODF / Fitting
   • [ ] randomSampling

9. Pole Figure Analysis

   • [ ] import / export
   • [ ] data correction
   • [ ] ODF reconstrution
   • [ ] The ambiguity problem

10. EBSD

    • [ ] Import / Export
    • [ ] reference frame alignment
    • [ ] data preprocessing
    • [ ] denoising,
    • [ ] visualization,
    • [ ] kernel average misorientation / KAM

11. Grains

    • [ ] grain reconstruction
    • [ ] shape parameters
    • [ ] orientation distribution parameters

12. Grain Boundaries

    • [ ] geometric properties
    • [ ] Tilt and Twist boundaries
    • [ ] special boundaries, CSL, Twinning

13. Tensors

    • [ ] Tensor Arithmetic
    • [ ] Average tensors
    • [ ] Piezoelectricity
    • [ ] birefringence,

14. Elasticity

    • [ ] wave velocities
    • [ ] isotropic theory
    • [ ] seismic plots

15. Plasticity

    • [ ] Schmidt factor
    • [ ] Taylor Model
    • [ ] Sachs Model
    • [ ] slip transmission
    • [ ] GND
    • [ ] texture evolution

16. spherical functions

[ralfHielscher]

Some nice pages where we can take inspiration from:

https://github.com/curtis-kim/myblog https://github.com/andrewbanchich/editorial-jekyll-theme