Metadata-Version: 2.1
Name: pocketchemist-nmr
Version: 0.2.1
Summary: NMR analysis tools for pocketchemist
Author: Justin L Lorieau
Author-email: justin@lorieau.com
License: GPLv3
Platform: UNKNOWN
Requires-Python: >=3.8
Requires-Dist: PyYAML (>=6.0)
Requires-Dist: loguru (>=0.5.3)
Requires-Dist: pluggy (>=1.0.0)
Requires-Dist: click (>=8.0.3)
Requires-Dist: click-option-group (>=0.5.3)
Requires-Dist: humanfriendly (>=10.0)
Requires-Dist: torch (>=1.1.20)
Requires-Dist: numpy (>=1.22.3)
Requires-Dist: scikit-image (>=0.19)
Requires-Dist: pyqt6 (>=6.3)
Requires-Dist: pyqtgraph (>=0.12)
Requires-Dist: pocketchemist (>=0.1)
Provides-Extra: docs
Requires-Dist: sphinx (>=4.4.0) ; extra == 'docs'
Requires-Dist: sphinx-click (>=3.1.0) ; extra == 'docs'
Requires-Dist: furo (>=2022.2.14) ; extra == 'docs'
Provides-Extra: tests
Requires-Dist: pytest (>=6.2) ; extra == 'tests'
Requires-Dist: pytest-repeat (>=0.9.1) ; extra == 'tests'
Requires-Dist: pytest-benchmark (>=3.4.1) ; extra == 'tests'
Requires-Dist: pytest-profiling (>=1.7.0) ; extra == 'tests'
Requires-Dist: pytest-cases (>=3.6.9) ; extra == 'tests'

# PocketChemist - NMR

The pocketchemist NMR plugin is used to process and analyze data from
Nuclear Magnetic Resonance (NMR).

## Contributing

### Procedure for new processing Methods

1. Implement the new procedure in the NMRSpectrum abstract base class

2. Implement metadata updates in the NMRSpectrum concrete subclasses as well
   as implementation details through parameters in the called parent method

3. Implement the CLI for the new process

4. Add tests to verify that the implementation matches an existing processed
   spectrum, if it exists

5. Add documentation for the new CLI functionality and python interface on 
   the new process

6. Increase the minor version


# Credits

- Icons by [Icons8](https://icons8.com/)

