# Welcome to PtyRAD!

Here's a short introductory video about PtyRAD on our official Youtube channel!

<iframe width="560" height="315" src="https://www.youtube.com/embed/XQ6wsMe9DZ0?si=uOmpR33H-InvpOD9" title="PtyRAD YouTube Channel" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen style="margin-bottom: 20px; border-radius: 8px;"></iframe>

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

:::{grid-item-card} 
:link: reference:quickstart
: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:launch
: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
quickstart
installation
```

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

```{toctree}
:hidden:
:caption: Params files
params_overview
examples/index
walkthrough/index
templates/index
```

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