# Welcome to cellpy's documentation

**version:** {{ ProjectVersion }}

:::{warning}
**cellpy 1.x maintenance window**

This documentation covers **cellpy version 1**. The 1.x line will be maintained
until approximately **July 2027** (one year from this notice). After that,
**cellpy version 2** will take over as the actively developed release line.
Plan migrations accordingly; new features and long-term support will focus on v2.
:::

```{include} adapted_readme.md
```

## Contents

```{toctree}
:maxdepth: 2

getting_started/index.md
fundamentals/index.md
examples/index.md
contributing/index.md
other/index.md
```

## License

`cellpy` is free software made available under the MIT License.

## Indices and tables

- {ref}`genindex`
- {ref}`modindex`
