Difference between revisions of "X2spinach.m"

From Spinach Documentation Wiki
Jump to: navigation, search
m (Normalise preformatted blank lines in function documentation blocks)
m (Rename Arguments section heading to Parameters)
Line 15: Line 15:
 
'''WARNING''': this function assumes that the [[Appendix_G:_SpinXML_infrastructure|SpinXML]] file has passed the validation against the schema, which may be obtained from http://spindynamics.org/SpinXML.php
 
'''WARNING''': this function assumes that the [[Appendix_G:_SpinXML_infrastructure|SpinXML]] file has passed the validation against the schema, which may be obtained from http://spindynamics.org/SpinXML.php
  
−
==Arguments==
+
==Parameters==
  
 
   filename      - SpinXML file name
 
   filename      - SpinXML file name

Revision as of 18:53, 5 June 2026

Reads SpinXML files and forms Spinach data structures. Syntax:

    [sys,inter]=x2spinach(filename,shielding_refs)

Parameters:

  shielding_refs - when absolute shielding is provided, this
                   array must give absolute shielding of the
                   corresponding nuclei in the reference sub-
                   stance, e.g. {{'1H',31.5},{'13C',189.7}}.
                   This is necessary because Spinach requires
                   chemical shifts rather than shieldings.

WARNING: this function assumes that the SpinXML file has passed the validation against the schema, which may be obtained from http://spindynamics.org/SpinXML.php

Parameters

  filename       - SpinXML file name

  shielding_refs - when absolute shielding is provided, this
                   array must give absolute shielding of the
                   corresponding nuclei in the reference sub-
                   stance, e.g. {{'1H',31.5},{'13C',189.7}}.
                   This is necessary because Spinach requires
                   chemical shifts rather than shieldings.
                   If chemical shifts are provided, use an
                   empty cell array.

Outputs

  sys, inter     - Spinach spin system input structures

See also

parsexml.m, gissmo2spinach.m, c2spinach.m, SpinXML infrastructure

Version 2.11, authors: Ilya Kuprov