File: reference.rst

package info (click to toggle)
kerchunk 0.2.9-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 135,172 kB
  • sloc: python: 6,477; makefile: 39
file content (110 lines) | stat: -rw-r--r-- 2,460 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
API Reference
*************

File format backends
--------------------

.. autosummary::
   kerchunk.hdf.SingleHdf5ToZarr
   kerchunk.grib2.scan_grib
   kerchunk.fits.process_file
   kerchunk.tiff.tiff_to_zarr
   kerchunk.netCDF3.NetCDF3ToZarr
   kerchunk.hdf4.HDF4ToZarr

.. autoclass:: kerchunk.hdf.SingleHdf5ToZarr
    :members:

.. autofunction:: kerchunk.grib2.scan_grib


.. autofunction:: kerchunk.fits.process_file

.. autofunction:: kerchunk.tiff.tiff_to_zarr

.. autoclass:: kerchunk.netCDF3.NetCDF3ToZarr
    :members: __init__, translate

.. autoclass:: kerchunk.hdf4.HDF4ToZarr
    :members: __init__, translate

Codecs
------

.. autosummary::
   kerchunk.codecs.GRIBCodec
   kerchunk.codecs.AsciiTableCodec
   kerchunk.codecs.FillStringsCodec
   kerchunk.codecs.VarArrCodec
   kerchunk.codecs.RecordArrayMember


.. autoclass:: kerchunk.codecs.GRIBCodec
    :members: __init__

.. autoclass:: kerchunk.codecs.AsciiTableCodec
    :members: __init__

.. autoclass:: kerchunk.codecs.FillStringsCodec
    :members: __init__

.. autoclass:: kerchunk.codecs.VarArrCodec
    :members: __init__

.. autoclass:: kerchunk.codecs.RecordArrayMember
    :members: __init__

.. autoclass:: kerchunk.codecs.ZlibCodec
    :members: __init__

Combining
---------

.. autosummary::
   kerchunk.combine.MultiZarrToZarr
   kerchunk.combine.merge_vars
   kerchunk.combine.concatenate_arrays
   kerchunk.combine.auto_dask
   kerchunk.combine.drop

.. autoclass:: kerchunk.combine.MultiZarrToZarr
    :members: __init__, append, translate

.. autofunction:: kerchunk.combine.merge_vars

.. autofunction:: kerchunk.combine.concatenate_arrays

.. autofunction:: kerchunk.combine.auto_dask

.. autofunction:: kerchunk.combine.drop

Utilities
---------

.. autosummary::
    kerchunk.utils.rename_target
    kerchunk.utils.rename_target_files
    kerchunk.utils.subchunk
    kerchunk.utils.dereference_archives
    kerchunk.utils.consolidate
    kerchunk.utils.do_inline
    kerchunk.utils.inline_array
    kerchunk.df.refs_to_dataframe

.. autofunction:: kerchunk.utils.rename_target

.. autofunction:: kerchunk.utils.rename_target_files

.. autofunction:: kerchunk.tiff.generate_coords

.. autofunction:: kerchunk.utils.subchunk

.. autofunction:: kerchunk.utils.dereference_archives

.. autofunction:: kerchunk.utils.consolidate

.. autofunction:: kerchunk.utils.do_inline

.. autofunction:: kerchunk.utils.inline_array

.. autofunction:: kerchunk.df.refs_to_dataframe