.. include:: ../../README.md
   :parser: myst_parser.sphinx_


| People who consider using this library should definitely look at `pypret <https://github.com/ncgeib/pypret>`_ the original implementation of the Common-Pulse-Retrieval-Algorithm (COPRA).



.. toctree::
   :maxdepth: 2
   :caption: Content

   example_overview_usage

   example_overview_methods
   example_overview_algorithms
   example_method_specific_algorithms

   example_nonlinear_optimization
   example_advanced_things

   pytree_structure
   definitions_and_formulas

   literature


.. toctree::
   :maxdepth: 1
   :caption: API

   frog
   chirp_scan
   tdp
   twodsi
   vampire
   streaking
   simulate_trace
   real_fields
   core
   utilities