Skip to content

Commit

Permalink
update readme.md and index.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
deepanshs committed Aug 11, 2020
1 parent f1bf164 commit f07c057
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,22 +9,22 @@

`mrsimulator` is a python package for computing fast solid-state magnetic resonance
(NMR) spectra. The library is optimized to compute both crystalline and amorphous-like
materials. The core of the `mrsimulator` library is written in C, wrapped and made
materials. The core of the `mrsimulator` library is written in C, wrapped, and made
available in python.

> :warning: The package is currently under development. We advice using with caution. Bug report are greatly appreciated.
## Why use mrsimulator?

- It is open source and free.
- It is open-source and free.
- It is a fast and versatile solid-state NMR simulator of one-dimensional static, MAS,
and VAS spectra of nuclei experiencing chemical shift (nuclear shielding) and quadrupolar
coupling interactions.
- Future release will include simulations of weakly coupled nuclei experiencing J and dipolar
couplings, and multi-dimensional NMR spectra.
- It is fully documented with a stable and simple API and is easily incorporated into your
python scripts and web apps.
- It is compatible with modern python package, such as scikit-learn, Keras, etc.
- It is compatible with modern python packages, such as scikit-learn, Keras, etc.
- Packages using mrsimulator -
- [mrinversion](https://mrinversion.readthedocs.io/en/latest/)

Expand Down
6 changes: 3 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,21 +73,21 @@ Welcome to the Mrsimulator documentation
``mrsimulator`` is a python package for computing fast solid-state magnetic
resonance (NMR) spectra. The library is optimized to compute both crystalline and
amorphous-like materials. The core of the ``mrsimulator`` library is written in C,
wrapped and made available in python.
wrapped, and made available in python.

----

**Why use mrsimulator?**

- It is open source and free.
- It is open-source and free.
- It is a fast and versatile solid-state NMR simulator of one-dimensional static, MAS,
and VAS spectra of nuclei experiencing chemical shift (nuclear shielding) and quadrupolar
coupling interactions.
- Future release will include simulations of weakly coupled nuclei experiencing J and dipolar
couplings, and multi-dimensional NMR spectra.
- It is fully documented with a stable and simple API and is easily incorporated into your
python scripts and web apps.
- It is compatible with modern python package, such as scikit-learn, Keras, etc.
- It is compatible with modern python packages, such as scikit-learn, Keras, etc.
- Packages using mrsimulator -

- `mrinversion <https://mrinversion.readthedocs.io/en/latest/>`_
Expand Down

0 comments on commit f07c057

Please sign in to comment.