source: sasmodels/doc/index.rst @ f64b154

Last change on this file since f64b154 was b955dd5, checked in by Paul Kienzle <pkienzle@…>, 6 years ago

fix sphinx errors

  • Property mode set to 100644
File size: 1.2 KB
RevLine 
[8ae8532]1sasmodels
2=========
3Small angle X-ray and Neutron scattering (SAXS and SANS) examines the
4scattering patterns produced by a beam travelling through the sample
5and scattering at low angles.  The scattering is computed as a function
6of reciprocal space $q$, which arises from a combination of beam wavelength
7and scattering angles. Each pixel on the detector corresponds to
8a different scattering angle, and has a distinct $q_x$ and $q_y$. If the
9sample is unoriented, the scattering pattern will appear as rings on the
10detector.  In this case, a circular average can be taken with 1-dimension
11data at $q = \surd (q_x^2 + q_y^2)$ compared to the orientationally
12averaged SAS scattering pattern.
13
[19dcb933]14The sasmodels package provides theory functions for small angle scattering
[8ae8532]15calculations for different shapes, including the effects of resolution,
16polydispersity and orientational dispersion.
[19dcb933]17
[f8060c5]18.. only:: html
[b955dd5]19
[19dcb933]20   :Release: |version|
21   :Date:    |today|
22
23   Download pdf version `here <SASModels.pdf>`_
24
25.. toctree::
[7bb290c]26   :maxdepth: 4
[19dcb933]27
28   guide/index.rst
[8ae8532]29   guide/models/index.rst
[d138d43]30   developer/index.rst
[19dcb933]31   api/index.rst
32
33Indices and Tables
34==================
35
36* :ref:`genindex`
37* :ref:`modindex`
38
[f8060c5]39.. only:: html
[b955dd5]40
[19dcb933]41  * :ref:`search`
Note: See TracBrowser for help on using the repository browser.