File: index.rst

package info (click to toggle)
pyfai 2026.02-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 96,100 kB
  • sloc: python: 70,217; lisp: 8,335; sh: 407; ansic: 247; makefile: 133; xml: 69
file content (29 lines) | stat: -rw-r--r-- 840 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
:Author: Jérôme Kieffer
:Date: 07/01/2021
:Keywords: Cookbook
:Target: Scientists

.. _usage:

Example of usage
================

This section presents typical usage of the *pyFAI* library.

It starts with recipies which present typical applications
like calibration of an experimental setup or integration of an image.
Those cookbooks are short tutorials which explain how to use *pyFAI* on a
practical example (5 mn to read).

Tutorials explain the Python interface of *pyFAI* and use the *Jupyter Notebook*
interface.
The two first tutorials are an introduction to the usage of *pyFAI* from Python for
diffraction data reduction.
The subsequent tutorials are more in depth explanation and require
a good Python fluency and to a certain extent, of the *pyFAI* library.

.. toctree::
   :maxdepth: 2

   cookbook/index
   tutorial/index