---
title: Ptyrax Documentation
---

# Ptyrax

This is the documentation for Ptyrax: An wave-optics inverse problem solver using JAX-based automatic differentiation, primarily focused on Ptychography, but adjustable to other domains.
To get started with installing/using Ptyrax in the command line for use in ptychography, see [Quickstart](quickstart). To use Ptyrax in your own code, checkout the tutorials. A full reference of all the functionality is available in [Ptyrax](ptyrax)

```{toctree}
:hidden:
:maxdepth: 1
:caption: Getting Started

quickstart
installation
usage
```

```{toctree}
:hidden:
:maxdepth: 1
:caption: Tutorials

tutorials/basic_reconstruction.ipynb
tutorials/through_focus_model.ipynb
tutorials/using_with_chromatix.ipynb
```

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

configuration
ptyrax
```

## Author

Sander Senhorst