Debian Codegraph @

docs/source/api.rst

raw
1 RAW API
2 ============
3
4 .. _api:
5
6 The RAW API allows you to install BioXTAS RAW as a python package without the
7 GUI. This lets you import RAW directly into your python scripts and use the
8 API to call any of the functions in RAW. This is great for creating custom
9 processing scripts, either for unusual datasets that aren't handled in the
10 GUI, or to ensure reproducibility in your analysis. It can also be used as
11 the basis for an open-source automated SAXS data processing pipeline at a
12 beamline or homesource.
13
14 .. toctree::
15 :maxdepth: 2
16 :includehidden:
17
18 api/installation
19 api/getting_started
20 api/examples
21 api/the_api
22
23