MC Result class

MCRun class

Results of a mc.run() call are returned as a MCRun object. This object contains all the relevant information about the simulation. By default arrays will be left on the GPU to avoid unnecessary data transfer. You can move all relevant data to the CPU with the cpu() method. Results can be saved to disk with the save() method. If you save to disk, input data, ouptut data and config will be saved to be able to replicate the run. Results can be visualized with the plot_domain() and plot_results() methods.

result = mc.run()
# save
result.save(project_name="pgse_test")
# move to cpu
result.cpu()
# visulize
result.plot_domain()
result.plot_results()

::: diffsim.mc.MCRun options: show_root_heading: true