{"id":5277,"date":"2021-03-16T19:03:53","date_gmt":"2021-03-16T19:03:53","guid":{"rendered":"http:\/\/ri.itservices.manchester.ac.uk\/csf3\/?page_id=5277"},"modified":"2025-06-19T18:01:02","modified_gmt":"2025-06-19T17:01:02","slug":"emsoft","status":"publish","type":"page","link":"https:\/\/ri.itservices.manchester.ac.uk\/csf3\/software\/applications\/emsoft\/","title":{"rendered":"EMsoft"},"content":{"rendered":"<h2>Overview<\/h2>\n<p><a href=\"http:\/\/vbff.materials.cmu.edu\/EMsoft\/\">EMsoft<\/a> is a program for the computation and visualization of scanning electron microscopy diffraction patterns, notably EBSD, ECP, TKD, and EKP. <\/p>\n<p>Version 5.0.3 is installed on the CSF. The EMsoftSDK and EMsoftData packages have been installed centrally. <\/p>\n<h2>Restrictions on use<\/h2>\n<p>There are no restrictions on access EMsoft on the CSF. All usage must adhere to the <a href=\"https:\/\/github.com\/EMsoft-org\/EMsoft\/blob\/develop\/License.txt\">license<\/a>.<\/p>\n<h2>Set up procedure<\/h2>\n<p>We now recommend loading modulefiles within your jobscript so that you have a full record of how the job was run. See the example jobscript below for how to do this. Alternatively, you may load modulefiles on the login node and let the job <abbr title=\"add '#$ -V' to your jobscript\">inherit these settings<\/abbr>.<\/p>\n<p>Load one of the following modulefiles:<\/p>\n<pre>\r\nmodule load apps\/gcc\/emsoft\/5.0.3                 # A release version (faster)\r\nmodule load apps\/gcc\/emsoft\/5.0.3-debug           # Debugging turned on during compiler (slower)\r\n<\/pre>\n<p>This will set the The <code>EMSOFTPATHNAME<\/code> environment variable to point to the central installation. All other EMSOFT env vars are unset and so the application should work in your current working directory.<\/p>\n<h2>Running the application<\/h2>\n<p>Please do not run EMsoft on the login node. Jobs should be submitted to the compute nodes via batch.<\/p>\n<h3>Serial batch job submission<\/h3>\n<p>Create a batch submission script (which will load the modulefile in the jobscript), for example:<\/p>\n<pre>\r\n#!\/bin\/bash --login\r\n#$ -cwd             # Job will run from the current directory\r\n                    # NO -V line - we load modulefiles in the jobscript\r\n\r\nmodule load apps\/gcc\/emsoft\/5.0.3\r\n\r\n# You may need to indicate where to write data and temp files.\r\nexport EMDATAPATHNAME=\/scratch\/$USER\/EMdata\/\r\nexport EMTMPPATHNAME=\/scratch\/$USER\/EMdata\/temp\/\r\nmkdir -p $EMDATAPATHNAME $EMTMPPATHNAME\r\n\r\n# Location where your Xtal data is stored. Change as required.\r\nexport EMXTALFOLDERPATHNAME=\/scratch\/$USER\/XtalFolder\/\r\n\r\n# Example running the EMEBSDDI app. The input .nml file needs modifying\r\n# to say how many cores are in use. Run the CSF helper script that adds\r\n# so lines to the end of the input file:\r\nemsoft-ri-cores-gpus-config $NSLOTS >> <em>input<\/em>.nml\r\n\r\n# Now run the app\r\nEMEBSDDI input.nml\r\n<\/pre>\n<p>Submit the jobscript using: <\/p>\n<pre>qsub <em>scriptname<\/em><\/pre>\n<p>where <em>scriptname<\/em> is the name of your jobscript.<\/p>\n<h3>GPU batch job submission<\/h3>\n<p>Create a batch submission script (which will load the modulefile in the jobscript), for example:<\/p>\n<pre>\r\n#!\/bin\/bash --login\r\n#$ -cwd             # Job will run from the current directory\r\n#$ -l v100=1        # Use a single GPU\r\n#$ -pe smp.pe 8     # Number of cores per GPU (2--8). Default is 1 if this line is missing.\r\n                    # NO -V line - we load modulefiles in the jobscript\r\n\r\nmodule load apps\/gcc\/emsoft\/5.0.3\r\n\r\n# You may need to indicate where to write data and temp files.\r\n# [On a GPU node you may want to use $TMPDIR instead of\r\n# \/scratch\/$USER in the commands below to use the fast \r\n# NVMe storage. Files will be deleted from $TMPDIR automatically\r\n# at the end of the job.]\r\nexport EMDATAPATHNAME=\/scratch\/$USER\/EMdata\/\r\nexport EMTMPPATHNAME=\/scratch\/$USER\/EMdata\/temp\/\r\nmkdir -p $EMDATAPATHNAME $EMTMPPATHNAME\r\n\r\n# Location where your Xtal data is stored. Change as required.\r\nexport EMXTALFOLDERPATHNAME=\/scratch\/$USER\/XtalFolder\/\r\n\r\n# Example running the EMEBSDDI app. The input .nml file needs modifying\r\n# to say how many cores are in use. Run the CSF helper script that adds\r\n# so lines to the end of the input file:\r\nemsoft-ri-cores-gpus-config $NSLOTS $NGPUS >> <em>input<\/em>.nml\r\n\r\n# Now run the app\r\nEMEBSDDI input.nml\r\n<\/pre>\n<p>Submit the jobscript using: <\/p>\n<pre>qsub <em>scriptname<\/em><\/pre>\n<p>where <em>scriptname<\/em> is the name of your jobscript.<\/p>\n<h2>Further info<\/h2>\n<ul>\n<li><a href=\"https:\/\/github.com\/EMsoft-org\/EMsoft\/wiki\">EMsoft wiki<\/a><\/li>\n<li><a href=\"https:\/\/github.com\/EMsoft-org\">EMsoft github site<\/a>\n<li><a href=\"\">EMsoft website<\/a>\n<\/ul>\n<h2>Updates<\/h2>\n<p>None.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Overview EMsoft is a program for the computation and visualization of scanning electron microscopy diffraction patterns, notably EBSD, ECP, TKD, and EKP. Version 5.0.3 is installed on the CSF. The EMsoftSDK and EMsoftData packages have been installed centrally. Restrictions on use There are no restrictions on access EMsoft on the CSF. All usage must adhere to the license. Set up procedure We now recommend loading modulefiles within your jobscript so that you have a full.. <a href=\"https:\/\/ri.itservices.manchester.ac.uk\/csf3\/software\/applications\/emsoft\/\">Read more &raquo;<\/a><\/p>\n","protected":false},"author":2,"featured_media":0,"parent":86,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-5277","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/ri.itservices.manchester.ac.uk\/csf3\/wp-json\/wp\/v2\/pages\/5277","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/ri.itservices.manchester.ac.uk\/csf3\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/ri.itservices.manchester.ac.uk\/csf3\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/ri.itservices.manchester.ac.uk\/csf3\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/ri.itservices.manchester.ac.uk\/csf3\/wp-json\/wp\/v2\/comments?post=5277"}],"version-history":[{"count":7,"href":"https:\/\/ri.itservices.manchester.ac.uk\/csf3\/wp-json\/wp\/v2\/pages\/5277\/revisions"}],"predecessor-version":[{"id":10394,"href":"https:\/\/ri.itservices.manchester.ac.uk\/csf3\/wp-json\/wp\/v2\/pages\/5277\/revisions\/10394"}],"up":[{"embeddable":true,"href":"https:\/\/ri.itservices.manchester.ac.uk\/csf3\/wp-json\/wp\/v2\/pages\/86"}],"wp:attachment":[{"href":"https:\/\/ri.itservices.manchester.ac.uk\/csf3\/wp-json\/wp\/v2\/media?parent=5277"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}