pyxem-demos icon indicating copy to clipboard operation
pyxem-demos copied to clipboard

Demo Reorganization:

Open CSSFrancis opened this issue 8 months ago • 2 comments

I think there are a couple of the Demos that I have duplicated/ better explained with the Examples added to pyxem. Also keeping the Demos up to date is a little difficult as they take a long time to run/ aren't run with the CI for pyxem.

I am going to remove:

  • [ ] 01 GaAs Nanowire - Data Inspection - Preprocessing - Unsupervised Machine Learning.ipynb --> Many small pre-processing examples etc. Make a new Notebook for a ML section.
    • [ ] https://github.com/pyxem/pyxem/pull/1082
  • [ ] 02 GaAs Nanowire - Phase Mapping - Orientation Mapping.ipynb --> Example in pyxem Orientation Mapping (included in PR)
    • [ ] https://github.com/pyxem/pyxem/pull/1076
  • [ ] 03 Reference Standards - Dimension Calibrations - Rotation Calibrations.ipynb --> Need to make a new example for this then remove
    • [ ] https://github.com/pyxem/pyxem/pull/1085
  • [ ] 04 Simulate Data - Phase Mapping - Orientation Mapping.ipynb --> Example in pyxem Orientation Mapping (included in PR)
    • [ ] https://github.com/pyxem/pyxem/pull/1076
  • [ ] 07 Azimuthal Integration Using pyFAI Detector.ipynb --> Already an Example
    • [x] https://github.com/pyxem/pyxem/pull/1026
    • [x] https://github.com/pyxem/pyxem/pull/993

From that point I would like to make subfolders in the demos:

  • [ ] DPC
    • [ ] Magnetic DPC Notebook
    • [ ] Electric DPC from Atomic Columns?
  • [ ] Amorphous and Organics Characterization
    • [ ] FEM
    • [ ] Angular Correlations and Symmetry Analysis
    • [ ] Vector Based Analysis
    • [ ] Organic Semiconduction Phase Mapping
  • [ ] Orientation Mapping
    • [ ] Orientation Mapping
    • [ ] G-Phase Mapping Example
  • [ ] Machiene Learning
    • [ ] Vector Based DBSCAN --> Using full 4D Vectors and just 2D Vectors
    • [ ] Applying a Neural Network using map and pytorch
    • [ ] Matrix Methods PCA SVD and NNMF
  • [ ] In Situ Characterization
    • [ ] Aligning a 5D Dataset
    • [ ] Crystalization Strucuture Characterization
    • [ ] Electron Correlation Micrscopy
  • [ ] Vector Analysis (Strain etc.)
    • [ ] Strain Mapping
    • [ ] Creating Virtual Images from Vectors
    • [ ] Vector Matching with Phases
  • [ ] External Packages Interfaces
    • [ ] Doing ptycography with LiberTEM
    • [ ] abTEM --> pyxem workflow

Thoughts? @tinabe this is a little bit of what we discussed before. I don't intend to do this before the workshop but it might be a good thing to keep in mind. Do other people have datasets or workflows they want added to this list?

CSSFrancis avatar May 31 '24 15:05 CSSFrancis