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

dataprocessing basics
-----------------------

.. _geobricks-ref:

geobricks
^^^^^^^^^^^^^^^

Loading/exporting & initializing datasets
"""""""""""""""""""""""""""""""""""""""""""

.. toctree::
   :maxdepth: 1
   
   api/load_any
   api/main_vars
   api/main_space_dims
   api/main_time_dims
   api/get_filelist
   api/export

Georeferencing
"""""""""""""""

.. toctree::
   :maxdepth: 1
   
   api/georef
   api/standardize_time_coord
   api/standardize_grid_mapping
   api/standardize_fill_value

File management
""""""""""""""""

.. toctree::
   :maxdepth: 1
   
   api/merge_data
   
Transforming, converting, clipping, rasterizing
""""""""""""""""""""""""""""""""""""""""""""""""

.. toctree::
   :maxdepth: 1
   
   api/transform

Other aliases
****************

.. toctree::
   :maxdepth: 1

   api/reproject
   api/convert

Derived partial functions
****************************

.. toctree::
   :maxdepth: 1
   
   api/clip
   api/rasterize

Secondary tools
*****************

.. admonition:: Under progress...
   :class: hint

   *Section to be completed*

.. toctree::
   :maxdepth: 1
   
   api/nearest
   api/format_xy_resolution
   api/get_shape

Compress & uncompress
""""""""""""""""""""""

.. toctree::
   :maxdepth: 1
   
   api/unzip
   api/gzip
   api/pack

Units operations
""""""""""""""""""

- hourly_to_daily()
- to_instant()
- convert_unit()

Extractions
""""""""""""

.. toctree::
   :maxdepth: 1
   
   api/timeseries

.. admonition:: Under progress...
   :class: hint

   *Section to be completed*

..
   .. automodule:: geobricks
       :members:
       :undoc-members:
       :show-inheritance:

.. _download-fr-ref:

download_fr
^^^^^^^^^^^^^^^

.. toctree::
   :maxdepth: 1
   
   api/download_fr/bnpe
   api/download_fr/hydrometry
   api/download_fr/sim2

.. _download-wl-ref:

download_wl
^^^^^^^^^^^^^^^^

.. toctree::
   :maxdepth: 1

   api/download_wl/era5-land

Secondary tools
""""""""""""""""""

.. toctree::
   :maxdepth: 1
   
   api/download_fr/valid_request

..
   .. automodule:: download_fr
       :members:
       :undoc-members:
       :show-inheritance:

.. _standardize-ref:

data-specific workflows
---------------------------

standardize_fr
^^^^^^^^^^^^^^^^^^

.. toctree::
   :maxdepth: 1
   
   api/standardize_fr/bdalti
   api/standardize_fr/sim2

.. admonition:: Under progress...
   :class: hint

   *Section to be completed*

model-specific workflows
--------------------------

cwatm
^^^^^^^^^^^^^^^^

.. toctree::
   :maxdepth: 1
   
   api/cwatm/dem
   api/cwatm/meteo

.. admonition:: Under progress...
   :class: hint

   *Section to be completed*


graphics
----------

ncplot
^^^^^^

.. toctree::
   :maxdepth: 1
   
   api/graphics/plot_time_series
   api/graphics/netcdf_to_animation

trajplot
^^^^^^^^

.. autoclass:: trajplot.Figure
    :members:
    :undoc-members:
    :show-inheritance:
	
cmapgenerator
^^^^^^^^^^^^^

.. automodule:: cmapgenerator
    :members:
    :undoc-members:
    :show-inheritance:

SIM2_tools
^^^^^^^^^^

.. automodule:: SIM2_tools
    :members:
    :undoc-members:
    :show-inheritance: