Data Formats Working Group: Difference between revisions

From canSAS
No edit summary
(29 intermediate revisions by 6 users not shown)
Line 1: Line 1:
= Overview =
As of early 2017, for new work, it is recommended to use the NXcanSAS (multi-dimensional)
standard for both 1-D and n-D data to maximize the chance that other
software will be able to read your data files.
We strongly encourage all authors of small-angle scattering related software to add support for NXcanSAS.
= Latest News =
Lots of discussion at [[canSAS-XI]] about metadata. Discussion and actions from the meeting are available [[canSAS-XI/DataFormats]]
[[User:Jemian|Jemian]] 2017-01: NXcanSAS released
[[User:Tobias Richter|Tobias Richter]] 2015-12 : Multidim moved to github a while ago
[[User:Ajj|Ajj]] 2012-07-31 : [[2012 Data Discussion| canSAS 2012 Data Formats discussion page]]
=  Links =
=  Links =


* '''Documentation''': [[cansas1d_documentation]]
=== nD: NXcanSAS ===
* '''TRAC''':       [http://svn.smallangles.net/trac/canSAS http://svn.smallangles.net/trac/canSAS]
 
* '''Subversion''': [http://svn.smallangles.net/svn/canSAS/1dwg http://svn.smallangles.net/svn/canSAS/1dwg]
standard for reduced small-angle scattering data of any dimension, using NeXus (HDF5)
* '''mailing list''': [http://smallangles.net/pipermail/cansas-1dwg_smallangles.net/ http://smallangles.net/pipermail/cansas-1dwg_smallangles.net/]
 
* '''v1.0''': 2017-01-18
* '''Announced''': 2017-06-06 (at [[canSAS-IX]])
* '''Documentation''': [http://download.nexusformat.org/doc/html/classes/applications/NXcanSAS.html http://download.nexusformat.org/doc/html/classes/applications/NXcanSAS.html]
* '''Examples''':      [https://github.com/canSAS-org/NXcanSAS_examples https://github.com/canSAS-org/NXcanSAS_examples]
* '''GitHub (NeXus)''': [https://github.com/nexusformat/definitions https://github.com/nexusformat/definitions]
* '''poster''': [[Media:2017-05-09_NXcanSAS_2D_format.pdf|PDF]]
 
=== 1D: cansas1d:1.1 ===
 
standard for 1-D reduced small-angle scattering data, using XML (text)
 
* v1.1: 2013-03-29
* v1.0: 2009-05-12
 
* '''Documentation''': [http://www.cansas.org/formats/canSAS1d/1.1/doc/ http://www.cansas.org/formats/canSAS1d/1.1/doc/]
* '''Examples''':      [https://github.com/canSAS-org/1dwg/tree/master/examples https://github.com/canSAS-org/1dwg/tree/master/examples]
* '''GitHub''':       [https://github.com/canSAS-org/1dwg  https://github.com/canSAS-org/1dwg]


= Members =
= Members =
* Andrew Jackson (NIST)
* Andrew Jackson (ESS)
* Pete Jemian (APS)
* Pete Jemian (APS)
* Steve King (ISIS)
* Steve King (ISIS)
* Ken Littrell (ORNL)
* Ken Littrell (ORNL)
* Andy Nelson (ANSTO)
* Andrew Nelson (ANSTO)
* Ron Ghosh (ILL)
* Ron Ghosh (ILL)
* Jan Ilavsky (APS)
* Jan Ilavsky (APS)
Line 23: Line 59:
* 2009-09-17 Agreed that v1.1 revision should be forthcoming with corrections/additions to be identified in TRAC tickets
* 2009-09-17 Agreed that v1.1 revision should be forthcoming with corrections/additions to be identified in TRAC tickets


= News/Status =
= Status =
 
[[User:Jemian|Jemian]] 11:10, 06 September 2008 (CDT) IgorPro GUI tool included in Irena [http://usaxs.xor.aps.anl.gov/staff/ilavsky/irena.html Irena] analysis suite<br />
[[User:Jemian|Jemian]] 11:10, 06 September 2008 (CDT) IgorPro GUI tool included in Irena [http://usaxs.xor.aps.anl.gov/staff/ilavsky/irena.html Irena] analysis suite<br />
[[User:Jemian|Jemian]] 13:08, 14 March 2008 (EDT) IgorPro tool to read cansas1d/1.0 XML files available<br />
[[User:Jemian|Jemian]] 13:08, 14 March 2008 (EDT) IgorPro tool to read cansas1d/1.0 XML files available<br />
Line 30: Line 65:
[[User:Jemian|Jemian]] 00:39, 21 December 2007 (EST) complete first draft (v0.1a) ready for comments from 1DWG <br />
[[User:Jemian|Jemian]] 00:39, 21 December 2007 (EST) complete first draft (v0.1a) ready for comments from 1DWG <br />
[[User:Jemian|Jemian]] 12:00, 14 December 2007 (EST) draft status updated <br />
[[User:Jemian|Jemian]] 12:00, 14 December 2007 (EST) draft status updated <br />
:[[User:Jemian|Jemian]] 17:07, 12 May 2009 (EDT) changeset 67 tagged as v1.0
[[User:Jemian|Jemian]] 17:07, 12 May 2009 (EDT) changeset 67 tagged as v1.0
 
= Examples and Usage =
The following are example v1.1 compliant 1D data files containing [besides essential metadata] - right-click & save as to view, stylesheet is on the TRAC site:<br /><br />
SANS data only [[media:ISIS_SASXML_v1_1_SANS_Example.XML | ISIS_SASXML_v1_1_SANS_Example.XML]]<br />
Wavelength-dependent transmission [[media:ISIS_SASXML_v1_1_Transmission_Example.XML | ISIS_SASXML_v1_1_Transmission_Example.XML]]<br />
Wavelength-dependent monitor spectrum [[media:ISIS_SASXML_v1_1_Monitor_Spectrum_Example.XML | ISIS_SASXML_v1_1_Monitor_Spectrum_Example.XML]]<br />
Wavelength-dependent detector efficiency ratio [[media:ISIS_SASXML_v1_1_Det_Efficiency_Example.XML | ISIS_SASXML_v1_1_Det_Efficency_Example.XML]]<br />
 
The files can be usefully displayed in many web browsers: [[Rendering_canSAS1D_in_Web_Browsers]]


[[Category:Working Groups]]
[[Category:Working Groups]]
= Mailing List=
The mailing list is now maintained by subscribing to this Google group:
* [https://groups.google.com/forum/#!forum/cansas-dfwg https://groups.google.com/forum/#!forum/cansas-dfwg]
Please address all questions and answers to this Google group.

Revision as of 09:25, 10 July 2019

Overview

As of early 2017, for new work, it is recommended to use the NXcanSAS (multi-dimensional) standard for both 1-D and n-D data to maximize the chance that other software will be able to read your data files.

We strongly encourage all authors of small-angle scattering related software to add support for NXcanSAS.

Latest News

Lots of discussion at canSAS-XI about metadata. Discussion and actions from the meeting are available canSAS-XI/DataFormats

Jemian 2017-01: NXcanSAS released

Tobias Richter 2015-12 : Multidim moved to github a while ago

Ajj 2012-07-31 : canSAS 2012 Data Formats discussion page

Links

nD: NXcanSAS

standard for reduced small-angle scattering data of any dimension, using NeXus (HDF5)

1D: cansas1d:1.1

standard for 1-D reduced small-angle scattering data, using XML (text)

  • v1.1: 2013-03-29
  • v1.0: 2009-05-12

Members

  • Andrew Jackson (ESS)
  • Pete Jemian (APS)
  • Steve King (ISIS)
  • Ken Littrell (ORNL)
  • Andrew Nelson (ANSTO)
  • Ron Ghosh (ILL)
  • Jan Ilavsky (APS)

Timeline

  • 2007-12-31 agree on v1.0 format
  • 2008-01-01 start implementing v1 at facilities
  • 2008-06 representative sampling of data available for inter-facility comparison
  • 2008-11-3 presentation of results at NOBUGS2008 meeting (http://www.nbi.ansto.gov.au/nobugs2008)
  • 2009-05-12 tagged SVN changeset 67 as v1.0 since it has been unmodified since January
  • 2009-09-17 Agreed that v1.1 revision should be forthcoming with corrections/additions to be identified in TRAC tickets

Status

Jemian 11:10, 06 September 2008 (CDT) IgorPro GUI tool included in Irena Irena analysis suite
Jemian 13:08, 14 March 2008 (EDT) IgorPro tool to read cansas1d/1.0 XML files available
Jemian 13:38, 25 February 2008 (EST) starting to add case studies
Jemian 00:39, 21 December 2007 (EST) complete first draft (v0.1a) ready for comments from 1DWG
Jemian 12:00, 14 December 2007 (EST) draft status updated
Jemian 17:07, 12 May 2009 (EDT) changeset 67 tagged as v1.0

Examples and Usage

The following are example v1.1 compliant 1D data files containing [besides essential metadata] - right-click & save as to view, stylesheet is on the TRAC site:

SANS data only ISIS_SASXML_v1_1_SANS_Example.XML
Wavelength-dependent transmission ISIS_SASXML_v1_1_Transmission_Example.XML
Wavelength-dependent monitor spectrum ISIS_SASXML_v1_1_Monitor_Spectrum_Example.XML
Wavelength-dependent detector efficiency ratio ISIS_SASXML_v1_1_Det_Efficency_Example.XML

The files can be usefully displayed in many web browsers: Rendering_canSAS1D_in_Web_Browsers

Mailing List

The mailing list is now maintained by subscribing to this Google group:

Please address all questions and answers to this Google group.