-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
cf845f0
commit f2cd594
Showing
2 changed files
with
30 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,16 @@ | ||
# SpinPlots: Simplified NMR plots with python | ||
SpinPlots is a Python package designed to simplify the process of loading and plotting NMR data, built on top of the NMRglue library. While NMRglue is a powerful tool for loading and analyzing NMR data, plotting with it can sometimes be cumbersome. SpinPlots aims to streamline this process, providing an intuitive interface for generating high-quality plots of NMR spectra with ease. | ||
# SpinPlots: Python NMR plots made easy | ||
|
||
SpinPlots is a Python package designed to streamline the process of loading and plotting NMR data. Built on top of the [NMRglue](https://www.nmrglue.com/), SpinPlots simplifies the plotting of NMR spectra. While NMRglue is a powerful tool for reading, processing, and analyzing NMR data, plotting with it can be cumbersome and code-intensive. SpinPlots addresses this by offering an intuitive interface for generating publication-ready plots with minimal effort. | ||
|
||
## Current features 🤌 | ||
- **One line of code == NMR spectrum**: Generate 1D and 2D Bruker NMR plots with a single function call. | ||
- **Automatic labeling**: Axis are automatically labeled with the corresponding nuclei and units. | ||
- **Customizable**: Fine-tune the look of your plots by loading them with Spinplots. | ||
|
||
## Documentation 📖 | ||
|
||
Complete documentation for SpinPlots, including installation instructions and usage guides can be found [here](https://carlosbornes.github.io/spinplots/). | ||
|
||
## Future features 🔜 | ||
- Extend support to non-Bruker spectra | ||
- Open to suggestions |