BornAgain  1.19.0
Simulate and fit neutron and x-ray scattering at grazing incidence
SimulationToPython Class Reference

Write a Python script that allows to run the current simulation. More...

Public Member Functions

std::string simulationPlotCode (const ISimulation &simulation)
 Returns a Python script that runs a simulation and plots the result. More...
 
std::string simulationSaveCode (const ISimulation &simulation, const std::string &fname)
 Returns a Python script that runs a simulation and saves the result to a file. More...
 

Detailed Description

Write a Python script that allows to run the current simulation.

Definition at line 29 of file SimulationToPython.h.

Member Function Documentation

◆ simulationPlotCode()

std::string SimulationToPython::simulationPlotCode ( const ISimulation simulation)

Returns a Python script that runs a simulation and plots the result.

Definition at line 476 of file SimulationToPython.cpp.

477 {
478  return simulationCode(simulation)
479  + "if __name__ == '__main__':\n"
480  " import ba_plot\n"
481  " sample = get_sample()\n"
482  " simulation = get_simulation(sample)\n"
483  " ba_plot.run_and_plot(simulation)\n";
484 }

Referenced by ExportToPython::simulationPlotCode().

◆ simulationSaveCode()

std::string SimulationToPython::simulationSaveCode ( const ISimulation simulation,
const std::string &  fname 
)

Returns a Python script that runs a simulation and saves the result to a file.

Definition at line 486 of file SimulationToPython.cpp.

488 {
489  return simulationCode(simulation)
490  + "if __name__ == '__main__':\n"
491  " sample = get_sample()\n"
492  " simulation = get_simulation(sample)\n"
493  " simulation.runSimulation()\n"
494  " ba.IntensityDataIOFactory.writeSimulationResult(simulation.result(), \""
495  + fname + "\")\n";
496 }

Referenced by ExportToPython::simulationSaveCode().


The documentation for this class was generated from the following files: