Brief overview of the Pulse Sequence Database
From NMR Wiki
The NMR Wiki Pulse Sequence Database consists of four things:
- pulse sequence records - pages about actual runnable pulse sequences
- NMR experiment records - pages about general concepts of NMR experiments (like COSY)
- pulse sequence file repository - holding of the source code
- search interface - a place where you can search for pulse sequences
First three components are all optional. This is made so that new records could be created in any order.
More details
How to get started?
Since NMR experiment and pulse sequence records are simple pages - just create a new page and start describing the item.
For NMR experiments - please describe what the experiment does and for pulse sequences - create a listing of parameters that user needs to set up.
To contribute files - email them as attachment to inbox@nmrwiki.org.
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.
Where to find more technical details?
Please, take a look at more detailed technical documentation about the Pulse Sequence Database.
