Changeset 4636


Ignore:
Timestamp:
Nov 2, 2020 10:25:36 AM (13 months ago)
Author:
toby
Message:

fixes for sphinx docs

Location:
trunk
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/GSASIIlattice.py

    r4582 r4636  
    2222*d* is the d-spacing, and :math:`d^*` is the reciprocal lattice spacing,
    2323:math:`Q = 2 \\pi d^* = 2 \\pi / d`.
    24 Note that GSAS-II variables ``p::Ai`` (``i``=0,1,...5) and ``p`` is a phase number are
     24Note that GSAS-II variables ``p::Ai`` (i = 0, 1,... 5) and ``p`` is a phase number are
    2525used for the *Ai* values. See :func:`A2cell`, :func:`cell2A` for interconversion between A and
    2626unit cell parameters; :func:`cell2Gmat` :func:`Gmat2cell` for G and cell parameters.
     
    2929*A* tensor terms (Ai, :math:`A_{i}`) so that A is redefined
    3030:math:`A = (\\begin{matrix} A_{0} + D_{11} & A_{1} + D_{22} & A_{2} + D_{33} & A_{3} + 2D_{12} & A_{4} + 2D_{13} & A_{5} + 2D_{23}\\end{matrix})`. See :func:`cellDijFill`.
    31 Note that GSAS-II variables ``p:h:Dij`` (``i``,``j``=1,2,3) and ``p`` is a phase number
     31Note that GSAS-II variables ``p:h:Dij`` (i,j = 1, 2, 3) and ``p`` is a phase number
    3232and ``h`` a histogram number are used for the *Dij* values.
    3333'''
  • trunk/GSASIIscriptable.py

    r4635 r4636  
    472472                                            be either a dictionary of 'low' and/or 'high',
    473473                                            or a list of 2 items [low, high]
    474 \\                    low                   Sets the low limit
    475 \\                    high                  Sets the high limit
     474\\                     low                   Sets the low limit
     475\\                     high                  Sets the high limit
    476476
    477477Sample Parameters                           Should be provided as a **list** of subkeys
    478478                                            to set or clear,\\e.g. ['DisplaceX', 'Scale']
    479 \\                    Absorption
    480 \\                    Contrast
    481 \\                    DisplaceX             Sample displacement along the X direction
    482 \\                    DisplaceY             Sample displacement along the Y direction
    483 \\                    Scale                 Histogram Scale factor
     479\\                     Absorption
     480\\                     Contrast
     481\\                     DisplaceX             Sample displacement along the X direction
     482\\                     DisplaceY             Sample displacement along the Y direction
     483\\                     Scale                 Histogram Scale factor
    484484
    485485Background                                  Sample background. Value will be a dict or
     
    491491                                            When value is a dict,
    492492                                            supply any of the following keys:
    493 \\                    type                  The background model, e.g. 'chebyschev-1'
    494 \\                    refine                The value of the refine flag, boolean
    495 \\                    'no. coeffs'          Number of coefficients to use, integer
    496 \\                    coeffs                List of floats, literal values for background
    497 \\                    FixedPoints           List of (2-theta, intensity) values for fixed points
    498 \\                    'fit fixed points'    If True, triggers a fit to the fixed points to
     493\\                     type                  The background model, e.g. 'chebyschev-1'
     494\\                     refine                The value of the refine flag, boolean
     495\\                     'no. coeffs'          Number of coefficients to use, integer
     496\\                     coeffs                List of floats, literal values for background
     497\\                     FixedPoints           List of (2-theta, intensity) values for fixed points
     498\\                     'fit fixed points'    If True, triggers a fit to the fixed points to
    499499                                            be calculated. It is calculated when this key is
    500500                                            detected, regardless of calls to refine.
    501 \\                    peaks                 Specifies a set of flags for refining
     501\\                     peaks                 Specifies a set of flags for refining
    502502                                            background peaks as a nested list. There may
    503503                                            be an item for each defined background peak
     
    509509                                            subkeys to
    510510                                            set or clear, e.g. ['X', 'Y', 'Zero', 'SH/L']
    511 \\                    U, V, W               Gaussian peak profile terms
    512 \\                    X, Y, Z               Lorentzian peak profile terms
    513 \\                    alpha, beta-0,        TOF profile terms
     511\\                     U, V, W               Gaussian peak profile terms
     512\\                     X, Y, Z               Lorentzian peak profile terms
     513\\                     alpha, beta-0,        TOF profile terms
    514514                      beta-1, beta-q,
    515 \\                    sig-0, sig-1,         TOF profile terms
     515\\                     sig-0, sig-1,         TOF profile terms
    516516                      sig-2, sig-q
    517 \\                    difA, difB, difC      TOF Calibration constants
    518 \\                    Zero                  Zero shift
    519 \\                    SH/L                  Finger-Cox-Jephcoat low-angle peak asymmetry
    520 \\                    Polariz.              Polarization parameter
    521 \\                    Lam                   Lambda, the incident wavelength
     517\\                     difA, difB, difC      TOF Calibration constants
     518\\                     Zero                  Zero shift
     519\\                     SH/L                  Finger-Cox-Jephcoat low-angle peak asymmetry
     520\\                     Polariz.              Polarization parameter
     521\\                     Lam                   Lambda, the incident wavelength
    522522===================== ====================  =================================================
    523523
Note: See TracChangeset for help on using the changeset viewer.