/nmrium

React component to display and process nuclear magnetic resonance (NMR) spectra.

Primary LanguageTypeScriptMIT LicenseMIT

NMRium

React component to display and process nuclear magnetic resonance (NMR) spectra.

Zakodium logo

Maintained by Zakodium

NPM version build status npm download DOI

Use it

Visit https://www.nmrium.org for examples of usage.

Use as a library in a React project

Install the package

npm install nmrium

OpenChemLib version

This module makes use of openchemlib/full.
If you use OpenChemLib somewhere else in your project, make sure to also import from openchemlib/full to avoid having multiple OCL versions in your bundle.

Use the component

import NMRium from 'nmrium';

function MyComponent() {
  return <NMRium />;
}

Development and testing

See General information for NMRium development.

There is an automatic build on each commit. You can test the latest build from main at:

https://dev.nmrium.org/

Want to play ? You can do some 1D NMR exercises ;)

https://www.nmrium.org/teaching#?toc=https://cheminfo.github.io/nmr-dataset2/toc.json

Also you can do some 2D NMR exercises ;)

https://www.nmrium.org/teaching#?toc=https://cheminfo.github.io/nmr-dataset1/data/2d.json

https://dev.nmrium.org?sampleURL=https%3A//cheminfo.github.io/nmr-dataset1/data/2d.json

You can do some 1D NMR tests/ exams ;)

https://dev.nmrium.org?sampleURL=https%3A//cheminfo.github.io/nmr-dataset2/exam.json

If you have jcamps accessible from an URL and that your server allow cross-origin you can directly open your file in the demo application:

https://dev.nmrium.org?sampleURL=https%3A//cheminfo.github.io/nmr-dataset2/100-86-7/1h.dx

Link loading the default samples test cases

https://dev.nmrium.org/?sampleURL=samples.json

You can debug Data and onDataChange callback ;)

https://dev.nmrium.org/#/test

Install and test locally

git clone https://github.com/cheminfo/nmrium.git
cd nmrium
npm i
npm start

Funding

Zakodium sàrl
Initiative zur Verbesserung der NMR-Datenqualität (IDNMR)
NFDI4Chem Chemistry Consortium in the NFDI
Universidad del Valle / Cali, Colombia
Union’s Horizon 2020 research and innovation programme under grant agreement No 957189

License

MIT