Changeset 291


Ignore:
Timestamp:
May 10, 2011 5:33:45 PM (10 years ago)
Author:
jemian
Message:

added first documentation using sphinx

Location:
trunk
Files:
11 added
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/GSASIIElem.py

    r265 r291  
    1919
    2020def GetFormFactorCoeff(El):
    21     """Read form factor coefficients from atomdata.asc file
    22     @param El: element 1-2 character symbol case irrevelant
    23     @return: FormFactors: list of form factor dictionaries
    24     each dictionary is:
    25     'Symbol':4 character element symbol with valence (e.g. 'NI+2')
    26     'Z': atomic number
    27     'fa': 4 A coefficients
    28     'fb':4 B coefficients
    29     'fc': C coefficient
     21    """Read form factor coefficients from `atomdata.asc` file
     22
     23    :param El: element 1-2 character symbol case irrevelant
     24    :return: `FormFactors`: list of form factor dictionaries
     25   
     26    Each form factor dictionary is:
     27   
     28    * `Symbol`: 4 character element symbol with valence (e.g. 'NI+2')
     29    * `Z`: atomic number
     30    * `fa`: 4 A coefficients
     31    * `fb`: 4 B coefficients
     32    * `fc`: C coefficient
    3033    """
    3134    ElS = El.upper()
Note: See TracChangeset for help on using the changeset viewer.