`_origen`#

This is the top-level _origen module which can be imported by Python

Submodules #

Functions #

initialize(): Called automatically when Origen is first loaded
status(): Returns the Origen status which informs whether an app is present, the Origen version,
version(): Returns the Origen version formatted into PEP440, e.g. “1.2.3.dev4”
config(): Returns the Origen configuration (as defined in origen.toml files)
config_metadata(): Undocumented.
app_config(): Returns the Origen application configuration (as defined in application.toml)
is_app_present(): Undocumented.
clean_mode(): clean_mode(name)
target_file(): target_file(name, dir)
test(): Prints out the AST for the current test to the console
test_ast(): Returns the AST for the current test in Python
flow(): Prints out the AST for the current flow to the console
flow_ast(): Returns the AST for the current flow in Python
output_directory(): Undocumented.
website_output_directory(): Undocumented.
website_source_directory(): Undocumented.
prepare_for_target_load(): This will be called by Origen immediately before loading a fresh set of targets
start_new_test(): Clears the current test (pattern) AST and starts a new one
unhandled_error_count(): Returns the number of unhandled errors that have been encountered since the Origen
set_output_dir(): Set the output directory to be used instead of <APP ROOT>/output
set_reference_dir(): Set the output directory to be used instead of <APP ROOT>/output
exit_pass(): Exit with a passing status code and print a big PASS to the console
exit_fail(): Exit with a failing status code and print a big FAIL to the console
enable_debug(): Enable Python source line tracking
set_operation(): Set the current Origen operation (generate, compile, etc.)
boot_users(): Undocumented.
file_handler(): Returns a file handler object (iterable) for consuming the file arguments

_origen.initialize(log_verbosity, verbosity_keywords, cli_location, cli_version, fe_pkg_loc, fe_exe_loc, invocation)#: Called automatically when Origen is first loaded

_origen.status()#: Returns the Origen status which informs whether an app is present, the Origen version, etc.

_origen.version()#: Returns the Origen version formatted into PEP440, e.g. “1.2.3.dev4”

_origen.config()#: Returns the Origen configuration (as defined in origen.toml files)

_origen.config_metadata()#

_origen.app_config()#: Returns the Origen application configuration (as defined in application.toml)

_origen.is_app_present()#

_origen.clean_mode(name)#: Sanitizes the given mode string and returns it, but will exit the process if it is invalid

_origen.target_file(name, dir)#: Sanitizes the given target/env name and returns the matching file, but will exit the process if it does not uniquely identify a single target/env file.

_origen.test()#: Prints out the AST for the current test to the console

_origen.test_ast()#: Returns the AST for the current test in Python

_origen.flow()#: Prints out the AST for the current flow to the console

_origen.flow_ast()#: Returns the AST for the current flow in Python

_origen.output_directory()#

_origen.website_output_directory()#

_origen.website_source_directory()#

_origen.prepare_for_target_load()#: This will be called by Origen immediately before loading a fresh set of targets

_origen.start_new_test(name=None)#: Clears the current test (pattern) AST and starts a new one

_origen.unhandled_error_count()#: Returns the number of unhandled errors that have been encountered since the Origen invocation started. An unhandled error is something that ultimately resulted in a pattern not being generated or something equally serious.

_origen.set_output_dir(dir)#: Set the output directory to be used instead of <APP ROOT>/output

_origen.set_reference_dir(dir)#: Set the output directory to be used instead of <APP ROOT>/output

_origen.exit_pass()#: Exit with a passing status code and print a big PASS to the console

_origen.exit_fail()#: Exit with a failing status code and print a big FAIL to the console

_origen.enable_debug()#: Enable Python source line tracking

_origen.set_operation(name)#: Set the current Origen operation (generate, compile, etc.)

_origen.boot_users()#

_origen.file_handler()#: Returns a file handler object (iterable) for consuming the file arguments given to the CLI

_origen#

Submodules#

Functions#

`_origen`#

Submodules #

Functions #