|
1 | 1 | # NMRium React Wrapper |
2 | | - |
3 | | -This React wrapper is designed to embed [NMRium](https://www.nmrium.org/), the NMR spectra processing tool, into other web application using iframe. It is already used in [nmrXiv](https://nmrxiv.org/) and [Chemotion](https://www.chemotion.net/), and we recommend to use it with any platform embedding [NMRium](https://www.nmrium.org/). |
| 2 | +[](https://opensource.org/licenses/MIT) |
| 3 | +[](https://github.com/NFDI4Chem/nmrium-react-wrapper/graphs/commit-activity) |
| 4 | +[](https://github.com/NFDI4Chem/nmrium-react-wrapper/issues) |
| 5 | +[](https://GitHub.com/NFDI4Chem/nmrium-react-wrapper/graphs/contributors/) |
| 6 | + |
4 | 7 |
|
5 | | -## Our Wiki |
6 | | -Please find in [our wiki](https://github.com/NFDI4Chem/nmrium-react-wrapper/wiki) more details about: |
| 8 | +This React wrapper is designed to embed [NMRium](https://www.nmrium.org/), the NMR spectra processing tool, into other web applications using iframe. It is already used in [nmrXiv](https://nmrxiv.org/) and [Chemotion](https://www.chemotion.net/), and we recommend using it with any platform embedding [NMRium](https://www.nmrium.org/). |
| 9 | + |
| 10 | +## [Wiki](https://github.com/NFDI4Chem/nmrium-react-wrapper/wiki) |
7 | 11 | - [Installation](https://github.com/NFDI4Chem/nmrium-react-wrapper/wiki/Installation) |
| 12 | +- [Contribution](https://github.com/NFDI4Chem/nmrium-react-wrapper/wiki/Contribution) |
8 | 13 | - [Wrapper Events](https://github.com/NFDI4Chem/nmrium-react-wrapper/wiki/Wrapper-Events) |
9 | 14 |
|
10 | | -## NMRium Version - Data Schema Version |
11 | | - |
12 | | -| NMRium Version | NMRium Data Schema Version | NMRium React Wrapper Version | Migration Script | |
13 | | -|:---- |:--- | :---- | :---- | |
14 | | -| v0.33.0 | v3 | Pre-release | [Migrate To Version3 script](https://github.com/cheminfo/nmr-load-save/blob/master/src/migration/migrateToVersion3.ts) | |
15 | | -| v0.34.0 (coming soon)| v4 | v1.0.0 (coming soon) | [Migrate To Version4 script](https://github.com/cheminfo/nmr-load-save/blob/master/src/migration/migrateToVersion4.ts) | |
| 15 | +## Versions |
16 | 16 |
|
17 | | -### Versions Update Protocol |
18 | | -- Whenever there is a new NMRium release (after complete tests): |
19 | | - - Hamed Musallam sends an email to contact persons from nmrXiv and Chemotion including details on the data schema updates and version in the new release. |
20 | | - - Noura Rayya updates NMRium version in the wrapper development environment. |
21 | | - - Noura Rayya tests 1D and 2D Bruker, JCAMP, and NMReData files. |
22 | | - - When the tests are passed, Chandu Nainala approves having the new NMRium release in the production environment of the wrapper. |
23 | | - - Noura Rayya sends an email to contact persons from nmrXiv and Chemotion including details on the data schema updates and version in the new release. |
| 17 | +| NMRium React Wrapper Version | NMRium Version | NMRium Data Schema Version | Migration Script | |
| 18 | +|:---- |:--- | :---- | :---- | |
| 19 | +| [Pre-release](https://github.com/NFDI4Chem/nmrium-react-wrapper/releases/tag/v0.0.1) | [v0.33.0](https://github.com/cheminfo/nmrium/releases/tag/v0.33.0) | [v3](/public/data/Data%20Schema%20Versions/V3/) | [Migration script](https://github.com/cheminfo/nmr-load-save/blob/master/src/migration/migrateToVersion3.ts) | |
| 20 | +| v1.0.0 (coming soon) | v0.34.0 (coming soon)| [v4](/public/data/Data%20Schema%20Versions/V4/) | [Migration script](https://github.com/cheminfo/nmr-load-save/blob/master/src/migration/migrateToVersion4.ts) | |
24 | 21 |
|
25 | 22 | ### Sources |
26 | | -- You can find all the updates about the versions of NMRium React Wrapper and the used NMRium and Data Schema following the link: [Versions Update Protocol](#versions-update-protocol) |
27 | 23 | - You can try out different versions of NMRium from this link: [https://cdn.nmrium.org/v0.33.0/index.html#/SamplesDashboard/4jld0i5hjhd/View](https://cdn.nmrium.org/v0.33.0/index.html#/SamplesDashboard/4jld0i5hjhd/View) by changing the version number in the link, for instance, to https://cdn.nmrium.org/v0.32.0/index.html#/SamplesDashboard/4jld0i5hjhd/View. |
28 | 24 | - You can find the scripts for NMRium Data Schema Version following [this link](https://github.com/cheminfo/nmr-load-save/tree/master/src/migration). |
29 | 25 | - You can find the changes between the schema and its earlier version documented at the top of its corresponding script from the link above. |
30 | | -- You can find examples of the NMRium Data Schema versions in the folder [Data Schema Versions](/public/data/Data%20Schema%20Versions/). |
31 | 26 | - You can find the original NMR files used to generate the Data Schema examples [following this link](https://drive.google.com/drive/folders/1pzr-SBy3Zg4fN7F612XmodIRDS5KPr46). |
32 | 27 |
|
33 | | -## Contribution |
34 | | -### Contribute to The Code |
35 | | -- **Branching**: Create a new branch from the`development`. The branch name should be all small with words separated by a hyphen. |
36 | | -- **Pull requests**: Pull requests should go towards (also known as a PR) to the `development` branch. Please link the issues which the pull request solves ti it. Finally, assign a reviewer. |
37 | | -- **Delete the stale branch**: After your branch is merged and the pull request is closed, please don't forget to delete your stale branch. |
38 | | - |
39 | | -### Contributors |
40 | | -- Hamed Musallam |
41 | | -- Lan Bao Quang Le |
42 | | -- Nisha Sharma |
43 | | -- Noura Rayya |
44 | | -- Venkata chandrasekhar Nainala (Chandu) |
45 | | - |
| 28 | +## License |
46 | 29 |
|
47 | | -## Versions Details |
48 | | -Current NMRium version: 0.33.0 |
| 30 | +This project is licensed under the MIT License - see the [LICENSE](https://github.com/NFDI4Chem/nmrium-react-wrapper/blob/main/LICENSE) file for details |
49 | 31 |
|
50 | | -## Relevant Links |
51 | | -Here you can find the links to NMRium and all the repositories we are aware of which use the wrapper. |
52 | 32 |
|
53 | | -- [NMRium](https://www.nmrium.org/) |
54 | | -- [nmrXiv](https://nmrxiv.org/) |
55 | | -- [Chemotion](https://www.chemotion.net/) |
| 33 | +## Maintained by |
| 34 | +[NMRium React Wrapper](https://dev.nmrium.org/) is developed and maintained by the [NFDI4Chem partners](https://www.nfdi4chem.de/) at the [Friedrich Schiller University](https://www.uni-jena.de/en/) Jena, Germany. |
| 35 | +The code for this web application is released under the [MIT license](https://opensource.org/licenses/MIT). Copyright © CC-BY-SA 2023 |
0 commit comments