Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Download and unzip
    1. Navigate on the landing page above to the executable package links, e.g. EMsoft-4.2.0-Win64.zip, or get the latest executables via the "BlueQuartz Nightly Builds" badge
    2. Download and extract the contents to a convenient directory (folder), like C:\Users\YOUR_USERNAME\Documents\EMsoft
  2. Tell Windows where the executables are located by adding the path to the executables, C:\Users\YOUR_USERNAME\Documents\EMsoft\bin, to environment variables (https://docs.microsoft.com/nb-no/windows/win32/shell/user-environment-variables)
  3. A command line and text editor is needed to interact with EMsoft. On Windows, using Visual Studio Code (https://code.visualstudio.com/) is recommended by Prof. Marc DeGraef, the main developer of EMsoft.
  4. Make sure EMsoft is setup correctly by opening a terminal in Visual Studio Code and executing the program EMOpenCLinfo (type EMOpenCLinfo and press enter)
  5. Setup the configuration by going to EMsoft's wiki pages on GitHub (https://github.com/EMsoft-org/EMsoft/wiki/Package-Configuration) and following the instructions there. (If you are unfamiliar with the Windows Command Prompt, here is a basic tutorial: https://www.makeuseof.com/tag/a-beginners-guide-to-the-windows-command-line/).
  6. All files produced by EMsoft are in the HDF5 format (Hierarchical Data Format version 5). To open these files, install an HDF file viewer like HDFView from the HDF Group: https://www.hdfgroup.org/downloads/hdfview. (They request that you register (for free) to download the viewer.)

...

To be able to index patterns stored in NORDIF's binary format, we need to address two issues:

  1. EMsoft (before version 5.0, in which I added a reader to EMsoft) cannot read the patterns stored in NORDIF's format, so, read the Pattern.dat file into KikuchiPy and write them to a .h5 file (HDF5), which can be read by EMsoft.
  2. EMsoft has no static background correction, so, before writing the patterns to the .h5 file, use the static_background_correction() method in KikuchiPy.

...