# `cfr`: a Python package for Climate Field Reconstruction

```{warning}
The v2026 backend is under active development. Documentation will be added as features are implemented.
```

```{note}
If you use `cfr` in any way for your publications, please cite:

+ Zhu, F., Emile-Geay, J., Hakim, G. J., Guillot, D., Khider, D., Tardif, R., & Perkins, W. A. (2024). cfr (v2024.1.26): a Python package for climate field reconstruction. Geoscientific Model Development, 17(8), 3409–3431. <https://doi.org/10.5194/gmd-17-3409-2024>
+ Zhu, F., Emile-Geay, J., Anchukaitis, K.J., McKay, N.P., Stevenson, S., Meng, Z., 2023. A pseudoproxy emulation of the PAGES 2k database using a hierarchy of proxy system models. Sci Data 10, 624. <https://doi.org/10.1038/s41597-023-02489-1>
```

Welcome to the v2026 documentation. This backend provides an alternative reconstruction framework within the cfr package.

&nbsp;

::::{grid} 1 1 2 2
:gutter: 2

:::{grid-item-card} Installation
:class-title: custom-title
:class-body: custom-body
:img-top: ../_static/installation.png
:link: ug-installation
:link-type: doc

Installation instructions.
:::

:::{grid-item-card} Data Assimilation
:class-title: custom-title
:class-body: custom-body
:img-top: ../_static/lmr.png
:link: ug-da
:link-type: doc

The Data Assimilation (DA) workflows.
:::

:::{grid-item-card} API
:class-title: custom-title
:class-body: custom-body
:img-top: ../_static/api.png
:link: ug-api
:link-type: doc

The essential API.
:::

```{toctree}
:maxdepth: 2
:hidden:
:caption: Contents
```

```{toctree}
:maxdepth: 2
:hidden:
:caption: User Guide

ug-installation
ug-da
ug-api
```

```{toctree}
:maxdepth: 2
:hidden:
:caption: Contributing Guide

cg-overview
cg-working-with-codebase
cg-updating-docs
```