Pulse sequence database documentation

From NMR Wiki

This is documents describes technical details of the pulse sequence database.

If you would like to contribute, but are not ready to get into the technicalities, please take a look at:

• Brief overview of the Pulse Sequence Database
• How to add files to the Pulse Sequence Database
• How to edit Pulse Sequence Database records

NMR experiment records

NMR experiment records are wiki pages that describe essence of the experiment regardless of implementation details on any specific hardware.

All of those documents fall into category "NMR experiment" and have automatically generated links to the relevant pulse sequence record pages.

Pulse sequence records

These are also regular pages - but in this case - one for each hardware-specific pulse sequence implementation.

Pulse sequence records can have the following (again, all of these are optional):

• listing and description of all pulse sequence parameters (see note below)
• a structured record about the pulse sequence
• link to downloadable pulse sequence source code and components
• link to the corresponding NMR experiment pages
• links to downloadable sample data

Note: internal pulse sequence parameters that are not exposed to the user should not be documented - because it is intended to be user documentation.

Pulse sequence file repository

The active file repository is actually a simple directory on the server.

This directory "revision controlled" with a mirror at the public github service.

You can contribute source code files either via github or by email at inbox@nmrwiki.org.