YARM: Yet Another Relaxation Matrix program
A program for performing nuclear spin relaxation calculations

Sections: Main | Using YARM | Subroutines | Theory | Samples | Resources
Subsections: Introduction | Relaxation | CSA | Structure | Data Fitting | Hydrodynamics | Interface | Utilities | System
System subroutines: writeInput | writeStructure | writeCSA | writeDynamics | writeExp_Vol | writeNxyz | writeiInxyzs

      The system YARM subroutines. These routines are used to prepare the input files for the various C programs that perform calculations. Usually, the end user will not ever need to know these routines exist, although, they are critical to understanding how YARM communicates with the C programs.


&writeInput

Summary:

Usage:
&writeInput( $file, \%YarmModel, \%NmrParams );

Inputfile_Write creates a "YARM input file" that allows for the PERL code to communicate with the C programs. This file contains all the information necessary to perform the desired calculation.

$file = Name of the file to create


&writeStructure

Summary:

Usage:
&writeStructure( $file, \%YarmModel );

Description:
This routine creates a YARM "structure file" from a supplied %YarmModel hash.

$file = name of output YARM structure file.

Example:


&writeCSA

Summary:

Usage:
&writeCSA( $file, \%YarmModel, \%NmrParams );

Description:
Creates a YARM CSA input file name $file.

The format for this file is:

Example:


&writeDynamics

Summary:

Usage:
&writeDynamics( $file, \%YarmModel );

Decsription:
Creates a YARM Dynamics input file name $file.

The format for this file is:
i ti Si

where i is the current atom number, ti is the current atom internal correlation time and Si is the current atom order parameter

Example:


&writeExp_Vol

Summary:

Usage:
&writeExp_Vol( $file, \%xyz, \%exp_vol );

Description:
This routine creates a YARM "experimental volumes" file that contains experimentally measured NOE volumes.

The expvol file format is "i j exp_vol\n"

Example:


&writeNxyz

Summary:

Usage:
&writeNxyz( $file, \%xyz );

Description:
Builds and writes to disk the "nxyz" file

$file = file name used to write the "nxyz" file
%xyz = one dimensional hash, used to get the coordinates for the "nxyz" file.

Example:


&writeiInxyzs

Summary:

Usage:
&writeiInxyz( $file, \%xyz );

Description:

Example:


&writeRij_Comparison

Summary:

Usage:
&writeRij_Comparison( \%reference_hash, \%rij_1, \%rij_2, $file);

Description:

Example:


&writeCorrelation

Summary:

Usage:
&writeCorrelation( \%reference_hash, \%hash1, \%hash2, $file );

Description:

Example:


&writeCoordinate_Axis

Summary:

Usage:
&writeCoordinate_Axis( $file, @Coordinate_Frame, $x, $y, $z );

Description:
This subroutine creates a mini-PDB file named $file that will represent a coordinate axis system. This is useful in viewing reference frames.

@Coordinate_Frame is nine numbers representing 3 coordinate axis vectors.

$x, $y, $z is the coordinate position of the origin of this coordinate frame

Example: