# Welcome to PtyRAD!

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

:::{grid-item-card} 
:link: reference:overview
:link-type: ref
:text-align: center

{material-regular}`rocket_launch;3em;sd-text-primary` **Get Started**

Follow our quick-start guide to install the package and run your first ptychographic reconstruction with *PtyRAD*.
:::

:::{grid-item-card}
:link: reference:params
:link-type: ref
:text-align: center

{material-regular}`menu_book;3em;sd-text-primary` **User Guide**

Learn about *PtyRAD*'s baisc principles, params file configurations, and different operation modes.
:::

:::{grid-item-card}
:link: reference:examples
:link-type: ref
:text-align: center

{material-regular}`collections;3em;sd-text-primary` **Examples**

Browse real examples of *PtyRAD* with params files and learn how to adapt it for your experiments.
:::

:::{grid-item-card}
:link: reference:api
:link-type: ref
:text-align: center

{material-regular}`code;3em;sd-text-primary` **API Reference**

Full API documentation for advanced users who want to know the internals of *PtyRAD*.
:::

::::

```{toctree}
:maxdepth: 3
:hidden:
```

```{toctree}
:hidden:
:caption: Get Started
overview
installation
quickstart
```

```{toctree}
:hidden:
:caption: User Guide
params/index
launch/index
examples/index
```

```{toctree}
:hidden:
:caption: Reference
changelog
api/index
```