# Changeset 129 for 1dwg

Ignore:
Timestamp:
Oct 2, 2009 5:47:47 PM (11 years ago)
Message:

more cross-references, formatting, & indices, refs #19

Location:
1dwg/trunk/doc
Files:
7 edited

Unmodified
Removed
• ## 1dwg/trunk/doc/src/cansas1d_binding_Python.xml

 r127
gnosis.xml.objectify The GnosisUtils (http://freshmeat.net/projects/gnosisxml/) offer a method to readany XML file into Python data structures. This utility does not validate the XML against aspecific XML Schema which can be both good (flexible, especially when XML Foreign Namespace elements are used) and not so good (XML content not guaranteed to be by the rules). The GnosisUtils http://freshmeat.net/projects/gnosisxml/ offer a method to read any XML file into Python data structures. This utility does not validate the XML against a specific XML Schema which can be both good (flexible, especially when XML Foreign Namespace elements are used) and not so good (XML content not guaranteed to be valid by the rules). A quick test of this turned up an acceptable result in that it was able to read several of the canSAS test XML files, including those with foreign namespaces.And it was very easy. (Especially with some help from http://www.xml.com/pub/a/2003/07/02/py-xml.html) A quick test of this turned up an acceptable result in that it was able to read several of the canSAS test XML files, including those with foreign namespaces. And it was very easy. (Especially with some help from http://www.xml.com/pub/a/2003/07/02/py-xml.html)
installation Here is the condensed installation (without all that output) steps. Your system may have gnosis already installed. You may also need sysAdmin privileges. You may need ... Here is the condensed installation (without all that output) steps. Your system may have gnosis already installed. You may also need sysAdmin privileges. You may need ... cd /tmp wget http://freshmeat.net/redir/gnosisxml/22028/url_tgz/Gnosis_Utils-1.2.2.tar.gz
• ## 1dwg/trunk/doc/src/cansas1d_definition_of_terms.xml

 r127 $Date$ This Definition of Terms may not be provided in future versions of this manual. This Definition of Terms may not be provided in future versions of this manual. Note: This section provides a glossary glossary definition of terms defining the details about each specific field (XPath string, XML elements and attributes) in the cansas1d/1.0 standard.cansas1d/1.0 standard /cs:SASroot [1..1] The canSAS reduced 1-D SAS data will be in the SASroot database. This is similar to NXroot used by NeXus. [1..1] The canSAS reduced 1-D SAS data will be in the SASroot SASroot database. This is similar to the root element of a NeXus file (NXroot). /cs:SASroot/cs:SASentry [1..inf] A single SAS scan is reported in a SASentry. A SASentry can use the optional "name" attribute to provide a string for this SASentry. Use of this string is not defined by this standard. [1..inf] A single SAS scan is reported in a SASentry. SASentry This is similar to NXentry used by NeXus. A SASentry can use an optional name attribute to provide a string for this SASentry. /cs:SASroot/cs:SASentry/@name [0..1] Optional string attribute to identify this particular SASentry. [0..1] Optional string attribute to identify this particular SASentry.  Use of the string associated with the name attribute is not defined by this standard.
• ## 1dwg/trunk/doc/src/cansas1d_element_SASdata.xml

 r128 SASdata SASdata parent: SASentry Idata Idata container Q Q Q=(4 pi; / lambda;) sin(theta;) where lambda; is the wavelength of the radiation and 2theta; is the angle through which the $Q=(4 \pi / \lambda) \sin(\theta)$ where $\lambda$ is the wavelength of the radiation and $2\theta$ is the angle through which the detected radiation has been scattered. The unit attribute is required. See rules for units for acceptable values. Either for acceptable values. Either 1/A or 1/nm are typical. I I Idev Idev Qdev Qdev dQw dQw dQl dQl Qmean Qmean Shadowfactor Shadowfactor {any} {any} container [0..inf] xlink:href="#cansas1d_documentation-element-any">{any} for more details. for more details.
• ## 1dwg/trunk/doc/src/elements.xml

 r127 xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"> Elements of the CanSAS XML standardThere are various elements (tag names) in the canSAS1d/1.0 standard. Each of these is described below.Starting the description of each element will be the current version control Revision and Date of the documentation section. There are various elements (tag names) in the canSAS1d/1.0 standard. Each of these is described below. The Name is the XML tag to be used for this element of the standard. The Type may be a container,
• ## 1dwg/trunk/doc/src/manual.xml

 r128 Preface CanSAS 1-D Data Format, v1.0 Provide a note here describing CanSAS and the initiative to establish a standard file format. "CanSAS" stands for "Collective Action for Nomadic Small-Angle Scatterers. This work is the initiative of the CanSAS 1D Data Formats Working Group, established at the canSAS-V workshop, NIST, Gaithersburg, Maryland, USA from October 29th to 31st 2007.  It derives many of its foundations from previous works such as the SASXML format, a joint collaboration between ISIS and ILL. The home page of the CanSAS 1D Data Formats Working Group http://www.smallangles.net/wgwiki/index.php/1D_Data_Formats_Working_Group describes the members, timelines, and current status. There is a discussion page for some matters that preceded this revision. http://www.smallangles.net/wgwiki/index.php/Talk:1D_Data_Formats_Working_Group
• ## 1dwg/trunk/doc/src/wiki.xml

 r128 Wiki Manual
Disclaimer This description is meant to inform the community how to layout the information within the XML files. However, should the information in this document and the cansas1d/1.0 SAS XML Schema (http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xsd) differ, the XML Schema will be deemed to have the most correct description of the standard.
Objective One of the first aims of the canSAS (Collective Action for Nomadic Small-Angle Scatterers) forum of users, software developers, and facility staff was to discuss One of the first aims of the canSAS canSAS (Collective Action for Nomadic Small-Angle Scatterers) forum of users, software developers, and facility staff was to discuss better sharing of SAS data analysis software. CanSAS (http://www.smallangles.net/canSAS) identified that a significant need within the SAS http://www.smallangles.net/canSAS identified that a significant need within the SAS community can be satisfied by a robust, self-describing, text-based, standard format to communicate reduced one-dimensional small-angle scattering data, ''I(Q)'', between users data of ''I(Q)'' and also any other descriptive information (metadata) about the sample, measurement, instrument, processing, or analysis steps. The cansas1d/1.0 standard meets the objectives for a 1D standard, incorporating The cansas1d/1.0 cansas1d/1.0 standard standard meets the objectives for a 1D standard, incorporating metadata about the measurement, parameters and results of processing or analysis steps. Even multiple measurements (related or unrelated) may be included within a single XML Overview The basic elements of the cansas1d/1.0 standard are shown in the following table. After an XML header, the root element of the file is [[cansas1d_SASroot | SASroot]] which contains one or more [[cansas1d_SASentry | SASentry]] elements, each of which After an XML header, the root element of the file is SASroot SASroot which contains one or more SASentry SASentry elements, each of which describes a single experiment (data set, time-slice, step in a series, new sample, etc.). Details of the [[cansas1d_SASentry | SASentry]] element are also shown in the next figure. Refer to the [[cansas1d_block_diagrams | block diagrams]] for alternative depictions. See SASentry element are also shown in the next figure. See http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xml >cansas1d.xml http://svn.smallangles.net/trac/canSAS/browser/1dwg/trunk/cansas1d.xml for an example XML file. Examples, Case Studies, and other background information are below. More discussion can be found on the [[1D_Data_Formats_Working_Group|canSAS 1D Data Formats Working Group]] page and its [[Talk:1D_Data_Formats_Working_Group|discussion]] page. Details about each specific field (XPath string, XML elements and attributes) are described on the [[cansas1d_definition_of_terms]] page. canSAS 1D Data Formats Working Group http://www.smallangles.net/wgwiki/index.php/1D_Data_Formats_Working_Group page and its discussion http://www.smallangles.net/wgwiki/index.php/Talk:1D_Data_Formats_Working_Group page.  A glossary glossarydefinition of terms defining the details about each specific field (XPath string, XML elements and attributes) is provided.
Note: See TracChangeset for help on using the changeset viewer.