:orphan:

===========
``_origen``
===========

.. automodule:: _origen

   .. contents::
      :local:


Submodules
==========

.. toctree::

   _origen.logger
   _origen.dut
   _origen.tester
   _origen.application
   _origen.interface
   _origen.producer
   _origen.services
   _origen.utility
   _origen.tester_apis
   _origen.standard_sub_blocks
   _origen.prog_gen
   _origen.users

.. currentmodule:: _origen


Functions
=========

- :py:func:`initialize`:
  Called automatically when Origen is first loaded

- :py:func:`status`:
  Returns the Origen status which informs whether an app is present, the Origen version,

- :py:func:`version`:
  Returns the Origen version formatted into PEP440, e.g. "1.2.3.dev4"

- :py:func:`config`:
  Returns the Origen configuration (as defined in origen.toml files)

- :py:func:`app_config`:
  Returns the Origen application configuration (as defined in application.toml)

- :py:func:`clean_mode`:
  clean_mode(name)

- :py:func:`target_file`:
  target_file(name, dir)

- :py:func:`file_handler`:
  Returns a file handler object (iterable) for consuming the file arguments

- :py:func:`test`:
  Prints out the AST for the current test to the console

- :py:func:`test_ast`:
  Returns the AST for the current test in Python

- :py:func:`flow`:
  Prints out the AST for the current flow to the console

- :py:func:`flow_ast`:
  Returns the AST for the current flow in Python

- :py:func:`output_directory`:
  Undocumented.

- :py:func:`website_output_directory`:
  Undocumented.

- :py:func:`website_source_directory`:
  Undocumented.

- :py:func:`on_windows`:
  Undocumented.

- :py:func:`on_linux`:
  Undocumented.

- :py:func:`prepare_for_target_load`:
  This will be called by Origen immediately before loading a fresh set of targets

- :py:func:`start_new_test`:
  Clears the current test (pattern) AST and starts a new one

- :py:func:`unhandled_error_count`:
  Returns the number of unhandled errors that have been encountered since the Origen

- :py:func:`set_output_dir`:
  Set the output directory to be used instead of <APP ROOT>/output

- :py:func:`set_reference_dir`:
  Set the output directory to be used instead of <APP ROOT>/output

- :py:func:`exit_pass`:
  Exit with a passing status code and print a big PASS to the console

- :py:func:`exit_fail`:
  Exit with a failing status code and print a big FAIL to the console

- :py:func:`enable_debug`:
  Enable Python source line tracking

- :py:func:`set_operation`:
  Set the current Origen operation (generate, compile, etc.)


.. autofunction:: initialize

.. autofunction:: status

.. autofunction:: version

.. autofunction:: config

.. autofunction:: app_config

.. autofunction:: clean_mode

.. autofunction:: target_file

.. autofunction:: file_handler

.. autofunction:: test

.. autofunction:: test_ast

.. autofunction:: flow

.. autofunction:: flow_ast

.. autofunction:: output_directory

.. autofunction:: website_output_directory

.. autofunction:: website_source_directory

.. autofunction:: on_windows

.. autofunction:: on_linux

.. autofunction:: prepare_for_target_load

.. autofunction:: start_new_test

.. autofunction:: unhandled_error_count

.. autofunction:: set_output_dir

.. autofunction:: set_reference_dir

.. autofunction:: exit_pass

.. autofunction:: exit_fail

.. autofunction:: enable_debug

.. autofunction:: set_operation