Template:Shakalab-pulse-sequence

From NMR Wiki

Briefly, this template looks like this:

{{shakalab-pulse-sequence
|name=
|family=
|synopsis=
|authors=
|nuclei=
|observe=
|dim=
}}

This template includes the main "pulse-sequence-record" template, where many of the fields are pre-filled.

Template manual

Template manual for the pulse sequences written in the A.J.Shaka Lab.

1) On your local file system prepare files :

• nmrwiki/psglib/<pulse_sequence_name.c> - pulse sequence source code
• nmrwiki/data/<pulse_sequence_name.fid.tar> - sample data with parameters (whole .fid directory)
• put all shaped pulses to nmrwiki/shapelib/
• optionally create nmrwiki/images/<pulse_sequence_name.pdf> - pulse sequence image pdf

2) Upload files

scp -r nmrwiki <shakalab_username>@nmrwiki.org /home/<shakalab_username>/psdb/vnmrsys

3) Create new page (use first method) with title: <3-4 word subtitle (pulse_sequence_name.c)>

4) In the new page fill in template shakalab-pulse-sequence with the following parameters:

Copy-paste template blank into the new page then just fill it out (use table below as reference) and save.

{{shakalab-pulse-sequence
|name=
|family=
|synopsis=
|authors=
|nuclei=
|observe=
|dim=
}}

In addition, you could do this:

• if you have sequence image file add "|image=true" into the template
• if XYZ pfg required, add "|xyz=true"
• if you want to flag it, add "|flag=true" or "|flag=Alert_page_title"
• add "|shaped_pulses=<comma separated list of file names>"
• add "|sample=Explanation for special sample requirements if any"

(This template is based on the Template:pulse-sequence-record, the following are modifications to usage notes of the parent template:)