Main Command Line Interface (cyclus.main
)¶
Main Cyclus CLI entry point.
-
class
cyclus.main.
AgentAnnotations
(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None)¶ Displays an agent annotations
-
class
cyclus.main.
AgentListing
(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None)¶ Displays an agent listing
-
class
cyclus.main.
AgentSchema
(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None)¶ Displays an agent schema
-
class
cyclus.main.
AgentVersion
(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None)¶ Displays an agent version
-
class
cyclus.main.
AllAgentListing
(option_strings, dest, nargs=0, **kwargs)¶ Displays all known cyclus agents
-
class
cyclus.main.
BuildPath
(option_strings, dest, nargs=0, **kwargs)¶ Prints the Cyclus Build Path
-
class
cyclus.main.
CMakeModulePath
(option_strings, dest, nargs=0, **kwargs)¶ Prints the Cyclus CMake Module Path
-
class
cyclus.main.
CyclusPath
(option_strings, dest, nargs=0, **kwargs)¶ Prints the Cyclus Path
-
class
cyclus.main.
CyclusVersion
(option_strings, dest, nargs=0, **kwargs)¶ Displays the cyclus version
-
class
cyclus.main.
IncludePath
(option_strings, dest, nargs=0, **kwargs)¶ Prints the Cyclus Include Path
-
class
cyclus.main.
InfileConverterAction
(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None)¶
-
class
cyclus.main.
InstallPath
(option_strings, dest, nargs=0, **kwargs)¶ Prints the Cyclus Install Path
-
class
cyclus.main.
JsonToPy
(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None)¶ converts JSON to Python
-
converter
()¶ Converts a JSON string into an equivalent Python string
-
name
= 'json_to_py'¶
-
-
class
cyclus.main.
JsonToXml
(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None)¶ converts JSON to XML
-
converter
()¶ Converts a JSON string into an equivalent XML string
-
name
= 'json_to_xml'¶
-
-
class
cyclus.main.
Metadata
(option_strings, dest, nargs=0, **kwargs)¶ Displays all known cyclus agents
-
class
cyclus.main.
NoAgent
(option_strings, dest, nargs=0, **kwargs)¶ Disables agent logging
-
class
cyclus.main.
NoMem
(option_strings, dest, nargs=0, **kwargs)¶ Disables mem logging
-
class
cyclus.main.
NucData
(option_strings, dest, nargs=0, **kwargs)¶ Prints the Nuclear data Path
-
class
cyclus.main.
PyToJson
(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None)¶ converts Python to JSON
-
converter
()¶ Converts a Python string into an equivalent JSON string
-
name
= 'py_to_json'¶
-
-
class
cyclus.main.
PyToXml
(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None)¶ converts Python to XML
-
converter
()¶ Converts a Python string into an equivalent XML string
-
name
= 'py_to_xml'¶
-
-
class
cyclus.main.
Restart
(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None)¶ Restart action for cyclus. Not supported.
-
class
cyclus.main.
RngPrint
(option_strings, dest, nargs=0, **kwargs)¶ Displays path to the rng schema
-
class
cyclus.main.
RngSchema
(option_strings, dest, nargs=0, **kwargs)¶ Displays path to the rng schema
-
class
cyclus.main.
Schema
(option_strings, dest, nargs=0, **kwargs)¶ Displays cyclus schema
-
class
cyclus.main.
Verbosity
(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None)¶ Sets versbosity level
-
class
cyclus.main.
WarnAsError
(option_strings, dest, nargs=0, **kwargs)¶ Sets warning to be errors
-
class
cyclus.main.
WarnLimit
(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None)¶ Sets warning limit
-
class
cyclus.main.
XmlToJson
(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None)¶ converts XML to JSON
-
converter
()¶ Converts an XML string into an equivalent JSON string
-
name
= 'xml_to_json'¶
-
-
class
cyclus.main.
XmlToPy
(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None)¶ converts XML to Python
-
converter
()¶ Converts an XML string into an equivalent Python string
-
name
= 'xml_to_py'¶
-
-
class
cyclus.main.
ZeroArgAction
(option_strings, dest, nargs=0, **kwargs)¶ An action with no arguments.
-
cyclus.main.
main
(args=None)¶ Main function for Cyclus CLI
-
cyclus.main.
make_agent_ctx
(spec)¶ Contsructs and agent and returns the agent and the context.
-
cyclus.main.
make_parser
()¶ Makes the Cyclus CLI parser.
-
cyclus.main.
print_master_schema
(ns)¶ Prints the master schema for the simulation
-
cyclus.main.
run_simulation
(ns)¶ Runs the simulation when we recieve an input file.
-
cyclus.main.
set_schema_path
(ns)¶ Sets the schema path on the namespace.