Changeset 241


Ignore:
Timestamp:
Aug 27, 2012 3:15:24 AM (7 years ago)
Author:
prjemian
Message:

refs #24

Location:
1dwg/trunk/doc/source
Files:
10 added
1 edited
1 moved

Legend:

Unmodified
Added
Removed
  • 1dwg/trunk/doc/source/index.rst

    r240 r241  
    11.. $Id$ 
    22 
    3 Documentation of the canSAS1d standard 
    4 ======================================= 
     3==================== 
     4canSAS1d data format 
     5==================== 
    56 
     7The canSAS1d data format is used to communicate one-dimensional 
     8reduced small-angle scattering data.  It is a text format and is based on XML. 
     9 
     10Objective 
     11============ 
     12 
     13One of the first aims of the **canSAS** (Collective Action for  
     14Nomadic Small-Angle Scatterers) forum of users, software  
     15developers, and facility staff was to discuss better sharing of SAS  
     16data analysis software. The canSAS (http://www.smallangles.net/canSAS) identified that a  
     17significant need within the SAS community can be satisfied by a  
     18robust, self-describing, text-based, standard format to communicate  
     19reduced one-dimensional small-angle scattering data, :math:`I(Q)`,  
     20between users of our facilities. Our goal has been to define such a  
     21format that leaves the data file instantly human-readable, editable  
     22in the simplest of editors, and importable by simple text import  
     23filters in programs that need not recognize advanced structure in  
     24the file nor require advanced programming interfaces. The file  
     25should contain both the primary data of :math:`I(Q)` and also any  
     26other descriptive information (metadata) about the sample,  
     27measurement, instrument, processing, or analysis steps. 
     28 
     29The cansas1d/1.1 standard meets the objectives for a 1D standard,  
     30incorporating metadata about the measurement, parameters and  
     31results of processing or analysis steps. Even multiple measurements  
     32(related or unrelated) may be included within a single XML file. 
    633 
    734 
     
    936   :maxdepth: 2 
    1037    
    11    contents 
    12  
     38   downloads 
     39   manual 
     40   status 
  • 1dwg/trunk/doc/source/manual.rst

    • Property svn:keywords changed from Date Revision Author HeadURL Id to Author Date Id Revision URL
    r240 r241  
    11.. $Id$ 
    22 
    3 Contents 
     3Manual 
    44==================================== 
    55 
    6 Contents: 
    76 
    87.. toctree:: 
    98   :maxdepth: 2 
    109 
     10   preface 
     11   specification 
     12   tutorial 
     13   bindings 
    1114 
    12  
    13 Indices and tables 
    14 ================== 
    15  
    16 * :ref:`genindex` 
    17 * :ref:`modindex` 
    18 * :ref:`search` 
    19  
     15.. 
     16    <xi:include href="intensity-problem.xml"/> 
     17    <xi:include href="examples.xml"/> 
     18    <xi:include href="glossary.xml"/> 
     19    <xi:include href="xml-help.xml"/> 
Note: See TracChangeset for help on using the changeset viewer.