SimulationToPython Class Reference

Description

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

Definition at line 29 of file SimulationToPython.h.

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...

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 484 of file SimulationToPython.cpp.

{
    return simulationCode(simulation)
           + "if __name__ == '__main__':\n"
             "    from bornagain import ba_plot as bp\n"
             "    bp.parse_args()\n"
             "    sample = get_sample()\n"
             "    simulation = get_simulation(sample)\n"
             "    result = simulation.simulate()\n"
             "    bp.plot_simulation_result(result)\n";
}

Referenced by Py::Export::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 496 of file SimulationToPython.cpp.

{
    return simulationCode(simulation)
           + "if __name__ == '__main__':\n"
             "    sample = get_sample()\n"
             "    simulation = get_simulation(sample)\n"
             "    result = simulation.simulate()\n"
             "    ba.IOFactory.writeSimulationResult(result, \""
           + fname + "\")\n";
}

Referenced by Py::Export::simulationSaveCode().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Sim/Export/SimulationToPython.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/Sim/Export/SimulationToPython.cpp