# {py:mod}`dawsonia.io`

```{py:module} dawsonia.io
```

```{autodoc2-docstring} dawsonia.io
:allowtitles:
```

## Submodules

```{toctree}
:titlesonly:
:maxdepth: 1

dawsonia.io._pdf
dawsonia.io._zarr
dawsonia.io._book
```

## Package Contents

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`_as_zarr_group <dawsonia.io._as_zarr_group>`
  - ```{autodoc2-docstring} dawsonia.io._as_zarr_group
    :summary:
    ```
* - {py:obj}`all_books <dawsonia.io.all_books>`
  - ```{autodoc2-docstring} dawsonia.io.all_books
    :summary:
    ```
* - {py:obj}`read_book <dawsonia.io.read_book>`
  - ```{autodoc2-docstring} dawsonia.io.read_book
    :summary:
    ```
* - {py:obj}`get_pages <dawsonia.io.get_pages>`
  - ```{autodoc2-docstring} dawsonia.io.get_pages
    :summary:
    ```
* - {py:obj}`get_pages_raw <dawsonia.io.get_pages_raw>`
  - ```{autodoc2-docstring} dawsonia.io.get_pages_raw
    :summary:
    ```
* - {py:obj}`get_station_name <dawsonia.io.get_station_name>`
  - ```{autodoc2-docstring} dawsonia.io.get_station_name
    :summary:
    ```
* - {py:obj}`get_year <dawsonia.io.get_year>`
  - ```{autodoc2-docstring} dawsonia.io.get_year
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`__all__ <dawsonia.io.__all__>`
  - ```{autodoc2-docstring} dawsonia.io.__all__
    :summary:
    ```
````

### API

````{py:data} __all__
:canonical: dawsonia.io.__all__
:value: >
   ('get_pages', 'get_station_name', 'get_year', 'read_book', 'Book', 'read_specific_table_format', 'ch...

```{autodoc2-docstring} dawsonia.io.__all__
```

````

````{py:function} _as_zarr_group(path_or_zarr: pathlib.Path | dawsonia.io._zarr.ZarrGroup) -> dawsonia.io._zarr.ZarrGroup
:canonical: dawsonia.io._as_zarr_group

```{autodoc2-docstring} dawsonia.io._as_zarr_group
```
````

````{py:function} all_books(top_dir, ext='.zarr.zip') -> typing.Iterator[pathlib.Path]
:canonical: dawsonia.io.all_books

```{autodoc2-docstring} dawsonia.io.all_books
```
````

````{py:function} read_book(path_file: str | pathlib.Path, first_page: int = 1, last_page: int = 1000000, page_middle: int | None = None, size_cell: list[float] | None = None, table_fmt_dir: str | pathlib.Path = Path('table_formats')) -> tuple[int, int, dawsonia.io._book.Book]
:canonical: dawsonia.io.read_book

```{autodoc2-docstring} dawsonia.io.read_book
```
````

````{py:function} get_pages(file: pathlib.Path | dawsonia.io._zarr.ZarrGroup, left_page: int, right_page: int) -> typing.Iterator[numpy.typing.NDArray]
:canonical: dawsonia.io.get_pages

```{autodoc2-docstring} dawsonia.io.get_pages
```
````

````{py:function} get_pages_raw(file: pathlib.Path | dawsonia.io._zarr.ZarrGroup, left_page: int, right_page: int) -> typing.Iterator[PIL.Image.Image]
:canonical: dawsonia.io.get_pages_raw

```{autodoc2-docstring} dawsonia.io.get_pages_raw
```
````

````{py:function} get_station_name(file: pathlib.Path | dawsonia.io._zarr.ZarrGroup)
:canonical: dawsonia.io.get_station_name

```{autodoc2-docstring} dawsonia.io.get_station_name
```
````

````{py:function} get_year(file: pathlib.Path | dawsonia.io._zarr.ZarrGroup)
:canonical: dawsonia.io.get_year

```{autodoc2-docstring} dawsonia.io.get_year
```
````