source: trunk/docs/source/exports.rst

Last change on this file was 2027, checked in by toby, 6 years ago

duplicate sphinx files for ReadTheDocs? trial

File size: 1.7 KB
Line 
1*GSAS-II Export Modules*
2====================================
3
4Exports are implemented by deriving a class from
5:class:`GSASIIIO.ExportBaseClass`. Initialization of
6``self.exporttype`` determines the type of export that will be performed
7('project', 'phase', 'single', 'powder', 'image', 'map' or (someday)
8'pdf') and of ``self.multiple``
9determines if only a single phase, data set, etc. can be exported at a
10time (when False) or more than one can be selected.
11
12Powder export routines may optionally define a ``Writer()``
13method that accepts the histogram tree name as well as a file name to
14be written. This allows :func:`ExportPowder` to use the exporter
15independent of the GUI.
16
17.. automodule:: G2export_examples
18    :members: 
19    :synopsis: Demonstrates sample code that exports a phase or dataset to
20      a text file.
21
22.. automodule:: G2export_csv
23    :members: 
24    :synopsis: Exports a phase or dataset to a spreadsheet via a
25       comma-separated-variable (csv) format file.
26
27.. automodule:: G2export_PDB
28    :members: 
29    :synopsis: Cartesian coordinate export, including PDB format
30
31.. automodule:: G2export_image
32    :members: 
33    :synopsis: Exports images
34 
35.. automodule:: G2export_map
36    :members: 
37    :synopsis: Export Fourier and charge-flip atomic density maps
38
39.. automodule:: G2export_shelx
40    :members: 
41    :synopsis: Export a phase in Shelx format
42
43.. automodule:: G2export_CIF
44    :members: 
45    :synopsis: Export a project in CIF format
46
47.. automodule:: G2export_pwdr
48    :members: 
49    :synopsis: Export powder data in GSAS and Topas formats
50
51.. automodule:: G2export_FIT2D
52    :members: 
53    :synopsis: Export powder data in Fit2D (.chi) format
54       
Note: See TracBrowser for help on using the repository browser.