.. _api-reference-api:

************************
``pytrnsys_process.api``
************************

Plotting
========

.. autosummary::
   :toctree: _as_gen
   :nosignatures:

    pytrnsys_process.api.line_plot
    pytrnsys_process.api.bar_chart
    pytrnsys_process.api.stacked_bar_chart
    pytrnsys_process.api.histogram
    pytrnsys_process.api.energy_balance
    pytrnsys_process.api.scatter_plot

Processing
==========

.. autosummary::
    :toctree: _as_gen
    :nosignatures:

    pytrnsys_process.api.process_single_simulation
    pytrnsys_process.api.process_whole_result_set
    pytrnsys_process.api.process_whole_result_set_parallel
    pytrnsys_process.api.do_comparison

Data Classes
============

.. autosummary::
    :toctree: _as_gen
    :nosignatures:

    pytrnsys_process.api.Simulation
    pytrnsys_process.api.SimulationsData

Utils
=====

.. autosummary::
    :toctree: _as_gen
    :nosignatures:

    pytrnsys_process.api.export_plots_in_configured_formats
    pytrnsys_process.api.load_simulations_data_from_pickle
    pytrnsys_process.api.load_simulation_from_pickle

Settings
========

.. autosummary::
    :toctree: _as_gen
    :nosignatures:

    pytrnsys_process.api.global_settings
    pytrnsys_process.api.Defaults
    pytrnsys_process.api.REPO_ROOT