API reference
=============

The ``soda_analyzer`` reference is generated from the Python source docstrings.
Each entry describes the signature, parameters, return values, and relevant
behavior. For an introduction with practical examples, see
:doc:`../tutorials/analyzer`.

Start with :class:`soda_analyzer.soda_lib_class`, then use the view appropriate to
the workflow recorded in the file. Expand a group in the sidebar to browse its
classes and functions; expand a class to find its methods and properties.

.. toctree::
   :maxdepth: 1

   databases
   states
   ape
   ezga
   nebscape
   diagnostics
   conversion

Compatibility names
-------------------

The reference pages use the class names defined in the source. The following
aliases are interchangeable with those classes and can be used in scripts.

.. list-table::
   :header-rows: 1

   * - Alias
     - Class or function reference
   * - ``SodaLibrary``
     - :class:`soda_analyzer.soda_lib_class`
   * - ``AkmcApeProcess``
     - :class:`soda_analyzer.process_class`
   * - ``AkmcApeState``
     - :class:`soda_analyzer.state_class`
   * - ``ApeEnvironment``
     - :class:`soda_analyzer.environment_class`
   * - ``ApeEnvironmentLibrary``
     - :class:`soda_analyzer.environment_lib_class`
   * - ``EzgaGenerationCommit``
     - :class:`soda_analyzer.ezga_generation_commit_class`
   * - ``EzgaSageStructurePayload``
     - :class:`soda_analyzer.ezga_sage_structure_payload_class`
   * - ``EzgaStructure``
     - :class:`soda_analyzer.ezga_structure_class`
   * - ``EzgaBlob``
     - :class:`soda_analyzer.ezga_blob_class`
   * - ``EzgaSimulationFrame``
     - :class:`soda_analyzer.ezga_simulation_frame_class`
   * - ``EzgaReactivityIrcPath``
     - :class:`soda_analyzer.ezga_reactivity_irc_path_class`
   * - ``EzgaLibrary``
     - :class:`soda_analyzer.ezga_lib_class`
   * - ``EzgaToolset``
     - :class:`soda_analyzer.ezga_lib_class`
   * - ``export_native_nebscape_format``
     - :func:`soda_analyzer.export_nebscape_native_format`