Difference between revisions of "Create.m"

From Spinach Documentation Wiki
Jump to: navigation, search
m (Rename Arguments section heading to Parameters)
(Update function See also links and function index membership)
Line 37: Line 37:
  
 
==See also==
 
==See also==
[[basis.m]], [[assume.m]], [[operator.m]], [[state.m]], [[hamiltonian.m]]
+
[[basis.m]], [[assume.m]], [[operator.m]], [[state.m]], [[hamiltonian.m]], [[reduce.m]], [[thermalize.m]], [[Kernel_functions]]
  
 
''Version 2.4, authors: [[Ilya Kuprov]], [[Hannah Hogben]], [[Konstantin Pervushin]], [[Luke Edwards]]''
 
''Version 2.4, authors: [[Ilya Kuprov]], [[Hannah Hogben]], [[Konstantin Pervushin]], [[Luke Edwards]]''

Revision as of 19:35, 6 June 2026

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)

Parameters

   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 simple spin system specification followed by a call to create.m appears below. There are hundreds of further examples in the example set.

    % Set the spin system
    sys.isotopes={'1H','1H'};
    inter.zeeman.scalar={0.0 0.0};
    inter.coordinates={[0.00 0.00 0.00];
                       [0.00 0.00 2.00]};
     
    % Magnet field
    sys.magnet=14.1;

    % Spinach housekeeping
    spin_system=create(sys,inter);

See also

basis.m, assume.m, operator.m, state.m, hamiltonian.m, reduce.m, thermalize.m, Kernel_functions

Version 2.4, authors: Ilya Kuprov, Hannah Hogben, Konstantin Pervushin, Luke Edwards