Ignore:
Timestamp:
Feb 20, 2018 2:16:21 PM (4 years ago)
Author:
toby
Message:

more doc fixes

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/GSASIIscriptable.py

    r3292 r3294  
    4949   
    5050:meth:`G2Project.set_refinement`
    51    This is passed a single dictionaries which is used to set parameters and flags.
     51   This is passed a single dict which is used to set parameters and flags.
    5252   These actions can be performed also in :meth:`G2Project.do_refinements`.
    5353
    54 Refinement step dicts
    55    A refinement step dict, as used in :meth:`G2Project.do_refinements` and described in
    56    :ref:`Project_dicts`,
    57    specifies parameter & refinement flag changes, which are usually followed by a refinement and
     54Refinement dicts
     55   A refinement dict sets up a single refinement step
     56   (as used in :meth:`G2Project.do_refinements` and described in
     57   :ref:`Project_dicts`).
     58   It specifies parameter & refinement flag changes, which are usually followed by a refinement and
    5859   optionally by calls to locally-defined Python functions. The keys used in these dicts are
    5960   defined in the :ref:`Refinement_recipe` table, below.
     
    6263are described in sections below, but the simplest way to access parameters and flags
    6364in a project is to use the above routines.
     65
     66=====================
     67Refinement parameters
     68=====================
     69The most complex part of scripting GSAS-II comes in setting up the input to control refinements, which is
     70described here.
    6471
    6572.. _Project_dicts:
     
    167174========== ============================================================================
    168175
    169 An example the performs a series of refinement steps follows:
     176An example that performs a series of refinement steps follows:
    170177
    171178.. code-block::  python
     
    190197   
    191198
    192 In this example, a separate refinement step will be performed for each dict in the list, since
    193 "skip" is not included.
     199In this example, a separate refinement step will be performed for each dict in the list (since
     200"skip" is not included).
    194201Note that in the second from last refinement step, parameters are both set and cleared.
    195202   
    196203.. _Refinement_parameters_kinds:
    197204
    198 =====================
    199 Refinement parameters
    200 =====================
     205----------------------------
     206Refinement parameter types
     207----------------------------
    201208
    202209Note that parameters and refinement flags used in GSAS-II fall into three classes:
     
    221228      histograms are not linked to all phases.) Typical HAP parameters include the
    222229      phase fractions, sample microstrain and crystallite size broadening terms,
    223       hydrostatic strain pertibations of the unit cell and preferred orientation
     230      hydrostatic strain perturbations of the unit cell and preferred orientation
    224231      values.
    225232      See the :ref:`HAP_parameters_table` table for the HAP parameters where access has
     
    228235.. _Refinement_parameters_fmt:
    229236
    230 ============================
    231 Refinement specifiers format
    232 ============================
    233 
    234 Refinement parameters are specified within dictionaries. The details of these dicts depends on the
     237=================================
     238Specifying Refinement Parameters
     239=================================
     240
     241Refinement parameter values and flags to turn refinement on and off are specified within dictionaries,
     242where the details of these dicts are organized depends on the
    235243type of parameter (see :ref:`Refinement_parameters_kinds`), with a different set
    236 of keys described below for each of the three parameter classes.
     244of keys (as described below) for each of the three types of parameters.
    237245
    238246.. _Histogram_parameters_table:
     
    257265.. code-block::  python
    258266
    259   gsas_proj.do_refinements([{
    260       'set': {
     267  gsas_proj.do_refinements([
     268      {'set': {
    261269          'Background': {'no.coeffs': 3, 'refine': True},
    262270          'Sample Parameters': ['Scale'],
    263271          'Limits': [10000, 40000]},
    264       'histograms': [1,2]
    265                             }])
    266 
    267 Note that below in Instrument Parameters,
    268 related profile parameters (such as U and V) are listed
     272      'histograms': [1,2]}
     273                            ])
     274
     275Note that below in the Instrument Parameters section,
     276related profile parameters (such as U and V) are grouped together but
    269277separated by commas to save space in the table.
    270278
     
    350358.. _HAP_parameters_table:
    351359
    352 ------------------------------
     360
    353361Histogram-and-phase parameters
    354362------------------------------
     
    515523
    516524============================================================
    517 GSASIIscriptable Application Layer
     525GSASIIscriptable Application Layer (API)
    518526============================================================
    519527
    520 This module provides a large number of classes and modules, as described below.
     528The large number of classes and modules in this module are described below.
    521529Most commonly a script will create a G2Project object using :class:`G2Project` and then
    522530perform actions such as
     
    526534(method :meth:`G2Project.do_refinements`).
    527535
    528 In some cases, it may be easier or more options may be available by direct access to
    529 methods inside :class:`G2PwdrData` or :class:`G2Phase`
     536In some cases, it may be easier to use
     537methods inside :class:`G2PwdrData` or :class:`G2Phase` or these objects
     538may offer more options.
    530539
    531540---------------------------------------------------------------
    532 Complete Documentation: GSASIIscriptable Classes and functions
     541Complete Documentation: All classes and functions
    533542---------------------------------------------------------------
    534543"""
Note: See TracChangeset for help on using the changeset viewer.