API
===
.. currentmodule:: primap2

Top-level API
-------------

.. autosummary::
    :toctree: generated/

    open_dataset
    ureg

.. toctree::
    :maxdepth: 2

    pm2io

.. currentmodule:: xarray

DataArray
---------

.. _daattr:

Attributes
~~~~~~~~~~

.. autosummary::
   :toctree: generated/
   :template: autosummary/accessor_attribute.rst

    DataArray.pr.loc
    DataArray.pr.gwp_context

.. _dameth:

Methods
~~~~~~~

.. autosummary::
   :toctree: generated/
   :template: autosummary/accessor_method.rst

    DataArray.pr.quantify
    DataArray.pr.dequantify
    DataArray.pr.convert_to_gwp
    DataArray.pr.convert_to_gwp_like
    DataArray.pr.convert_to_mass
    DataArray.pr.fill_all_na
    DataArray.pr.sum
    DataArray.pr.count
    DataArray.pr.downscale_timeseries
    DataArray.pr.__getitem__
    DataArray.pr.set
    DataArray.pr.coverage
    DataArray.pr.to_df

Dataset
-------

.. _dsattr:

Attributes
~~~~~~~~~~

.. autosummary::
   :toctree: generated/
   :template: autosummary/accessor_attribute.rst

    Dataset.pr.loc
    Dataset.pr.references
    Dataset.pr.rights
    Dataset.pr.contact
    Dataset.pr.title
    Dataset.pr.comment
    Dataset.pr.institution
    Dataset.pr.history

.. _dsmeth:

Methods
~~~~~~~

.. autosummary::
   :toctree: generated/
   :template: autosummary/accessor_method.rst

    Dataset.pr.ensure_valid
    Dataset.pr.to_netcdf
    Dataset.pr.to_df
    Dataset.pr.to_interchange_format
    Dataset.pr.quantify
    Dataset.pr.dequantify
    Dataset.pr.fill_all_na
    Dataset.pr.sum
    Dataset.pr.count
    Dataset.pr.gas_basket_contents_sum
    Dataset.pr.fill_na_gas_basket_from_contents
    Dataset.pr.downscale_timeseries
    Dataset.pr.downscale_gas_timeseries
    Dataset.pr.__getitem__
    Dataset.pr.set
    Dataset.pr.coverage