Python API for running Cyclus:

[jbae11]

Taking some hints from the OpenMC team, a Python API to construct input to export to XML would be beneficial. I think the Workbench auto-schema-generation capabilities can be leveraged for input checking for this.

Something like below for a full input:

import cyclus

archetype_list = []
archetype_list.append(cyclus.Archetype(lib='agents', name='NullRegion')
archetype_list.append(cyclus.Archetype(lib='cycamore', name='Source')
archetype_list.append(cyclus.Archetype(lib='cycamore', name='Sink')
archetypes = cyclus.Archetypes(archetype_list)
arcehtypes.export_to_xml()

control = cyclus.Control(duration=100, startmonth=1, ...)
control.export_to_xml()

facility_list = []
facility.append(cyclus.Facility(name=source, config='Source', outcommod='natl_u'))
facility.append(cyclus.Facility(name=sink, config='Sink', incommod='natl_u'))
facilities = cyclus.Facilities(facility_list)
facilities.export_to_xml()

institution_list = []
inst1 = cyclus.Institution(name='inst1', config='DeployInst', config_dict={'prototypes': ['sink', 'source'], 'build_times': [1,2], ... })
...
institutions = cyclus.Institutaions(institution_list)


cyclus.simulation.run()