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

This page provides an auto-generated summary of ``xbitinfo``'s API.
For more details and examples, refer to the relevant chapters in the main part of the
documentation.


xbitinfo
--------

.. currentmodule:: xbitinfo.xbitinfo

.. autosummary::
    :toctree: api/

    get_bitinformation
    get_keepbits
    get_prefect_flow

Bitrounding
-----------

.. currentmodule:: xbitinfo.bitround

.. autosummary::
    :toctree: api/

    xr_bitround
    jl_bitround
    bitround_along_dim

Save compressed
---------------
.. currentmodule:: xbitinfo.save_compressed
.. autosummary::
    :toctree: api/

    get_chunksizes
    ToCompressed_Netcdf
    get_compress_encoding_nc
    ToCompressed_Zarr
    get_compress_encoding_zarr

Graphics
--------
.. currentmodule:: xbitinfo.graphics
.. autosummary::
    :toctree: api/

    plot_bitinformation
    plot_distribution
    add_bitinfo_labels