Changeset 1123 for trunk/exports


Ignore:
Timestamp:
Oct 25, 2013 2:24:22 PM (8 years ago)
Author:
toby
Message:

add import and export routines to sphinx

Location:
trunk/exports
Files:
7 edited

Legend:

Unmodified
Added
Removed
  • trunk/exports/G2export_CIF.py

    r1117 r1123  
    88# $Id$
    99########### SVN repository information ###################
    10 '''Code to export a GSAS-II project as a CIF. Variable `self.mode`
    11 determines the type of CIF that is created:
     10'''
     11*Module G2export_CIF: CIF Exports*
     12------------------------------------------------------
     13
     14This implements a complex exporter :class:`ExportCIF` that can implement an
     15entire project in a complete CIF intended for submission as a
     16publication. In addition, there are two subclasses of :class:`ExportCIF`:
     17:class:`ExportPhaseCIF` and :class:`ExportDataCIF` that
     18export a single phase or data set. Note that ``self.mode`` determines
     19what is written:
    1220
    1321 * `self.mode="simple"` creates a simple CIF with only coordinates
    14    for at most a single phase (:class:`ExportSimpleCIF`), while
    15 
    16  * `self.mode="full"` creates a complete CIF of project (:class:`ExportCIF`).
     22   or data, while
     23
     24 * `self.mode="full"` creates a complete CIF of project.
     25 
    1726'''
    1827
  • trunk/exports/G2export_PDB.py

    r1115 r1123  
    88# $Id$
    99########### SVN repository information ###################
    10 '''Code to demonstrate how export routines are created
     10'''
     11*Module G2export_PDB: Macromolecular export*
     12--------------------------------------------
     13Code to export a phase into the venerated/obsolete (pick one)
     14ASCII PDB format. Also defines exporter :class:`ExportPhaseCartXYZ`
     15which writes atom positions in orthogonal coordinates for a phase.
     16
    1117'''
    1218import numpy as np
  • trunk/exports/G2export_csv.py

    r1115 r1123  
    88# $Id$
    99########### SVN repository information ###################
    10 '''Code to create .csv (comma-seaparate variable) files for
    11 GSAS-II data export
     10'''
     11*Module G2export_csv: Spreadsheet export*
     12-------------------------------------------
     13
     14Code to create .csv (comma-separated variable) files for
     15GSAS-II data export to a spreadsheet program, etc.
     16
    1217'''
    1318import os.path
  • trunk/exports/G2export_examples.py

    r1115 r1123  
    88# $Id$
    99########### SVN repository information ###################
    10 '''Code to demonstrate how GSAS-II data export routines are created
     10'''
     11*Module G2export_examples: Examples*
     12-------------------------------------------
     13
     14Code to demonstrate how GSAS-II data export routines are created. The
     15classes defined here, :class:`ExportPhaseText`,
     16:class:`ExportSingleText`, :class:`ExportPowderReflText`,
     17and :class:`ExportPowderText` each demonstrate a different type
     18of export. Also see :class:`G2export_map.ExportMapASCII` for an
     19example of a map export.
     20
    1121'''
    1222import os.path
     
    148158        self.CloseFile()
    149159        print(str(hist)+' written to file '+str(self.filename))                       
    150 
    151160class ExportPowderReflText(G2IO.ExportBaseclass):
    152161    '''Used to create a text file of reflections from a powder data set
  • trunk/exports/G2export_image.py

    r1115 r1123  
    88# $Id$
    99########### SVN repository information ###################
    10 '''Code to demonstrate how export routines are created.
    11 This loads in an image and saves it in PNG format
     10'''
     11*Module G2export_image: 2D Image data export*
     12------------------------------------------------------
     13
     14Demonstrates how an image is retrieved and written. Uses
     15a SciPy routine to write a PNG format file.
    1216'''
    1317import os.path
  • trunk/exports/G2export_map.py

    r1122 r1123  
    88# $Id$
    99########### SVN repository information ###################
    10 '''Code to demonstrate how export routines are created: Export a Fourier or
    11 Charge-flip map.
    1210'''
    13 import os.path
     11*Module G2export_map: Map export*
     12-------------------------------------------
     13
     14Code to write Fourier/Charge-Flip atomic density maps out in formats that
     15can be read by external programs. At present a GSAS format
     16that is supported by FOX and DrawXTL
     17(:class:`ExportMapASCII`) and the CCP4 format that
     18is used by COOT (:class:`ExportMapCCP4`) are implemented.
     19'''
     20import os
    1421import GSASIIpath
    1522import numpy as np
     
    7279
    7380class ExportMapCCP4(G2IO.ExportBaseclass):
    74     import os
    7581    '''Used to create a text file for a phase
    7682
  • trunk/exports/G2export_shelx.py

    r1117 r1123  
    88# $Id$
    99########### SVN repository information ###################
    10 '''Code to export coordinates in SHELX format, as best as I can makes sense of it
     10'''
     11*Module G2export_shelx: Examples*
     12-------------------------------------------
     13
     14Code to export coordinates in the SHELX .ins format
     15(as best as I can makes sense of it).
     16
    1117'''
    1218import os.path
Note: See TracChangeset for help on using the changeset viewer.