python wrapper installation - EMsoft-org/EMsoft GitHub Wiki

python wrapper installation instructions

Here are the instructions to build the python wrappers and the associated documentation:

  • To compile EMsoft, you need to first build the Software Developer Kit for your operating system.
  • Then, follow the instructions on the main EMsoft page to compile the EMsoft modules and programs.
  • Next, complete the EMsoft package configuration following the EMsoft Wiki Package Configuration help page.
  • To test if EMsoft has been configured correctly, run a simple example such as the Crystal Data Entry Example.
  • (Suggested) Install a recent version of the Anaconda distrinution to install packages such as Python, numpy, and many others.
  • Install the blas, lapack, and tgmlib libraries from the command line by executing the conda install lapack. These libraries will be linked later to some of the modules for convenient linear algebra operations.
  • Install f90wrap and make sure f90wrap and f2py-f90wrap are added to your shell path. These are the two important executables needed to generate the wrappers.
  • From the shell command line, cd into the pyEMsoft folder in the EMsoft repository and execute the shell script with ./run_pyEMsoft.sh. This will take quite a while.
  • Once the shell script ends you should have a fully functioning python wrapper library. You can also generate the documentation using the ./run_docs.sh script.