Template:Legaultlab-pulse-sequence

From NMR Wiki

Jump to: navigation, search

Briefly, this template looks like this:

{{legault-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 P. Legault 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 <username>@nmrwiki.org /home/<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 legaultlab-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.

{{legaultlab-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:)

parameter(s)usage
namename of pulse sequence source file without .c
familylinks to pulse sequence family pages example [[HNCO]] - it's just a link to HNCO page
synopsisone line text summary
authorscomma separated list of initials as set in Legault lab registry page
imageif "true" link to pdf with pulse sequence image will be shown
xyzif set as "true", message that triple axis pfg probe is required will show up
nucleiexample HCN - all nuclei involved in the experiment, including decoupling
observeexample C - observe nucleus
dimnumber of dimensions
shaped_pulsesexample "BIP600.RF,sinc.RF"
samplespecial sample requirements (13C labeled, etc.)
flagif "true" or "Some_page_title" red flag will show with a warning message
Personal tools