<commit_before>.. _api:

API Reference
=============

.. automodule:: pygmt

.. currentmodule:: pygmt

Plotting
--------

All plotting is handled through the :class:`pygmt.Figure` class and its methods.

.. autosummary::
    :toctree: generated

    Figure

Plotting data and laying out the map:

.. autosummary::
    :toctree: generated

    Figure.basemap
    Figure.coast
    Figure.colorbar
    Figure.plot
    Figure.plot3d
    Figure.contour
    Figure.grdcontour
    Figure.grdimage
    Figure.grdview
    Figure.legend
    Figure.logo
    Figure.image
    Figure.shift_origin
    Figure.text
    Figure.meca
    Figure.inset

Color palette table generation:

.. autosummary::
    :toctree: generated

    makecpt

Saving and displaying the figure:

.. autosummary::
    :toctree: generated

    Figure.savefig
    Figure.show
    Figure.psconvert


Data Processing
---------------

Operations on tabular data:

.. autosummary::<commit_msg>Reorder plotting functions in API list (#854)<commit_after>.. _api:

API Reference
=============

.. automodule:: pygmt

.. currentmodule:: pygmt

Plotting
--------

All plotting is handled through the :class:`pygmt.Figure` class and its methods.

.. autosummary::
    :toctree: generated

    Figure

Plotting data and laying out the map:

.. autosummary::
    :toctree: generated

    Figure.basemap
    Figure.coast
    Figure.colorbar
    Figure.contour
    Figure.grdcontour
    Figure.grdimage
    Figure.grdview
    Figure.image
    Figure.inset
    Figure.legend
    Figure.logo
    Figure.meca
    Figure.plot
    Figure.plot3d
    Figure.shift_origin
    Figure.text

Color palette table generation:

.. autosummary::
    :toctree: generated

    makecpt

Saving and displaying the figure:

.. autosummary::
    :toctree: generated

    Figure.savefig
    Figure.show
    Figure.psconvert


Data Processing
---------------

Operations on tabular data:

.. autosummary::
{'fraction_non_alphanumeric': 0.112668743509865, 'fraction_numerical': 0.002596053997923157, 'mean_word_length': 2.5884543761638734, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2437108', 'n_tokens_mistral': 641, 'n_tokens_neox': 610, 'n_words': 157}