Difference between revisions of "Create.m"
| Line 1: | Line 1: | ||
| − | + | {{DISPLAYTITLE:create.m}} __NOTOC__ | |
| + | The entry function of the ''Spinach'' kernel that creates the spin system object that the rest of the library requires to run. It checks and absorbs interaction specifications, and writes some useful diagnostics to the console. | ||
| + | |||
| + | ==Syntax== | ||
| + | |||
| + | [[spin_system]]=create([[sys]],[[inter]]) | ||
| + | |||
| + | ==Arguments== | ||
| + | |||
| + | [[sys]] - spin system and instrument specification | ||
| + | structure, see the [[spin system specification]] | ||
| + | section of the online manual | ||
| + | |||
| + | [[inter]] - interaction specification structure, see | ||
| + | see the [[spin system specification]] section | ||
| + | of the online manual | ||
| + | |||
| + | ==Outputs== | ||
| + | |||
| + | [[spin_system]] - the primary object used by Spinach | ||
| + | to store simulation information | ||
| + | |||
| + | ==Examples== | ||
| + | A description of what is done in the example below: | ||
| + | |||
| + | % Comment | ||
| + | matlab code | ||
| + | |||
| + | % Comment | ||
| + | matlab code | ||
| + | |||
| + | ==Notes== | ||
| + | Further notes on good and bad practices. | ||
| + | |||
| + | ==See also== | ||
| + | Links to related functions. | ||
| + | |||
| + | |||
| + | ''Version 2.4, authors: [[Author 1]]'' | ||
| + | |||
| + | |||
| + | |||
| + | the function that creates the [[Appendix D: kernel data structures|spin_system]] object. Syntax: | ||
spin_system=create(sys,inter) | spin_system=create(sys,inter) | ||
| − | where the two parameters contain the information about the spin system and the interactions | + | where the two parameters contain the information about the spin system and the interactions. |
Revision as of 14:42, 9 July 2019
The entry function of the Spinach kernel that creates the spin system object that the rest of the library requires to run. It checks and absorbs interaction specifications, and writes some useful diagnostics to the console.
Syntax
spin_system=create(sys,inter)
Arguments
sys - spin system and instrument specification structure, see the spin system specification section of the online manual inter - interaction specification structure, see see the spin system specification section of the online manual
Outputs
spin_system - the primary object used by Spinach to store simulation information
Examples
A description of what is done in the example below:
% Comment
matlab code
% Comment
matlab code
Notes
Further notes on good and bad practices.
See also
Links to related functions.
Version 2.4, authors: Author 1
the function that creates the spin_system object. Syntax:
spin_system=create(sys,inter)
where the two parameters contain the information about the spin system and the interactions.
