Skip to content

Commit

Permalink
Changes to readme and new release
Browse files Browse the repository at this point in the history
  • Loading branch information
carlosbornes committed Nov 5, 2024
1 parent cf845f0 commit f2cd594
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 2 deletions.
14 changes: 14 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,20 @@ All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.1.0]

## Added

- **Terminal functionality**: Added `bruker2csv` to convert NMR data into CSV from the terminal.
- **Plotting functions**: Added the following functions to streamline plotting:
- `bruker1d` for generating 1D NMR plots
- `bruker1d_grid` for generating subplots
- `bruker2d` for generating 2D NMR plots
- **NMR dataframe**: Added the `nmr_df` function to create a Pandas DataFrame from NMR data, for further data manipulation, analysis and plotting.
- **Tutorials**:
- Creating 1D and 2D plots using the spinplots functions.
- Obtain a Pandas DataFrame from NMR data for custom plot styling and manipulation.

## [0.0.1]

### Added
Expand Down
18 changes: 16 additions & 2 deletions README.md
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

0 comments on commit f2cd594

Please sign in to comment.