Changeset 2817 for trunk/docs


Ignore:
Timestamp:
May 2, 2017 10:03:41 AM (6 years ago)
Author:
vondreele
Message:

major revision - move all importers to GSASIIobj & make them independent of wx so they can be used in a scripting environment.
Still to move are PhaseSelector?, and 3 BlockSelector? dialogs

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/docs/source/imports.rst

    r2802 r2817  
    33
    44Imports are implemented by deriving a class from
    5 :class:`GSASIIIO.ImportPhase`, :class:`GSASIIIO.ImportStructFactor`,
    6 :class:`GSASIIIO.ImportPowderData`
     5:class:`GSASIIobj.ImportPhase`, :class:`GSASIIobj.ImportStructFactor`,
     6:class:`GSASIIobj.ImportPowderData`
    77or :class:`GSASIIIO.ImportPowderData` (which are in turn
    8 derived from :class:`GSASIIIO.ImportBaseclass`)
     8derived from :class:`GSASIIobj.ImportBaseclass`)
    99to implement import of
    1010a phase, a single crystal or a powder dataset, respectively.
    … …  
    147147_________________________
    148148
    149 Note that the base class (:class:`GSASIIIO.ImportBaseclass`) supplies two routines,
    150 :meth:`~GSASIIIO.ImportBaseclass.BlockSelector` and
    151 :meth:`~GSASIIIO.ImportBaseclass.MultipleBlockSelector` that are useful for
    152 selecting amongst one or more datasets (and perhaps phases) for
     149Note that GSASIIIO supplies three routines,
     150:meth:`~GSASIIIO.BlockSelector`
     151:meth:`~GSASIIIO.MultipleBlockSelector` and
     152:meth:`~GSASIIIO.MultipleChoiceSelector` that are useful for
     153selecting amongst one or more datasets (and perhaps phases) or data items for
    153154``Reader()`` routines that may encounter more than one set of information
    154155in a file.
    155156Likewise, when an operation will take some time to complete,
    156 use :meth:`~GSASIIIO.ImportBaseclass.ShowBusy` and
    157 :meth:`~GSASIIIO.ImportBaseclass.DoneBusy` to show the user
    158 that something is happening.
    159 
     157use :meth:`~GSASIIIO.ShowBusy` and
     158:meth:`~GSASIIIO.DoneBusy` to show the user that something is happening.
    160159
    161160ContentsValidator()
    … …  
    205204----------------------------------------
    206205Phase import routines are classes derived from
    207 :class:`GSASIIIO.ImportPhase`. 
     206:class:`GSASIIobj.ImportPhase`. 
    208207They must be found in files named `G2phase*.py` that are in the Python path
    209208and the class must override the ``__init__`` method and add a ``Reader`` method.
    … …  
    231230---------------------------------------------
    232231Powder data import routines are classes derived from
    233 :class:`GSASIIIO.ImportPowderData`.
     232:class:`GSASIIobj.ImportPowderData`.
    234233They must be found in files named `G2pwd*.py` that are in the Python path
    235234and the class must override the ``__init__`` method and add a
    … …  
    275274-----------------------------------------------------
    276275Single crystal data import routines are classes derived from
    277 , :class:`GSASIIIO.ImportStructFactor`.
     276, :class:`GSASIIobj.ImportStructFactor`.
    278277They must be found in files named `G2sfact*.py` that are in the Python path
    279278and the class must override the ``__init__`` method and add a ``Reader`` method.
    … …  
    292291-----------------------------------------------------
    293292Small angle scattering data import routines are classes derived from
    294 , :class:`GSASIIIO.ImportSmallAngle`.
     293, :class:`GSASIIobj.ImportSmallAngle`.
    295294They must be found in files named `G2sad*.py` that are in the Python path
    296295and the class must override the ``__init__`` method and add a ``Reader`` method.
    … …  
    348347-----------------------------------------------------
    349348PDF import routines are classes derived from
    350 :class:`GSASIIIO.ImportPDFData`.
     349:class:`GSASIIobj.ImportPDFData`.
    351350See :ref:`Writing a Import Routine<Import_Routines>` for general information on importers.
    352351
    … …  
    359358-----------------------------------------------------
    360359Reflectometry import routines are classes derived from
    361 :class:`GSASIIIO.ImportReflectometryData`.
     360:class:`GSASIIobj.ImportReflectometryData`.
    362361See :ref:`Writing a Import Routine<Import_Routines>` for general information on importers.
    363362
Note: See TracChangeset for help on using the changeset viewer.