Metadata-Version: 2.4
Name: simpyson
Version: 0.0.1
Summary: A python interface to Simpson
Author-email: Carlos Bornes <carlos.bornes@natur.cuni.cz>
License: BSD-3
Project-URL: repository, https://github.com/carlosbornes/simpyson
Project-URL: documentation, https://carlosbornes.github.io/simpyson/
Project-URL: changelog, https://github.com/simpyson/simpyson/blob/main/CHANGELOG.md
Keywords: NMR,Simulation
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: numpy
Requires-Dist: ase
Requires-Dist: pandas
Requires-Dist: soprano
Requires-Dist: plotly
Requires-Dist: PyQt5
Requires-Dist: PyQtWebEngine
Provides-Extra: dev
Requires-Dist: codecov-cli>=0.4.1; extra == "dev"
Requires-Dist: pytest>=7.4.0; extra == "dev"
Requires-Dist: pytest-cov>=3.0.0; extra == "dev"
Requires-Dist: ruff>=0.0.285; extra == "dev"
Provides-Extra: docs
Requires-Dist: mkdocs-material>=9.4.0; extra == "docs"
Requires-Dist: mkdocstrings[python]>=0.22.0; extra == "docs"
Requires-Dist: mkdocs-gen-files>=0.5.0; extra == "docs"
Requires-Dist: mkdocs-literate-nav>=0.6.0; extra == "docs"
Requires-Dist: pillow>=10.0.0; extra == "docs"
Requires-Dist: cairosvg>=2.7.1; extra == "docs"
Dynamic: license-file

# SimPYson: A Pythonic Interface for SIMPSON

[![DOI](https://zenodo.org/badge/813117518.svg)](https://doi.org/10.5281/zenodo.14041918)

SimPYson is a Python package designed to simplify the use of [SIMPSON](https://inano.au.dk/about/research-centers-and-projects/nmr/software/simpson), a powerful code to simulate solid-state NMR experiments. Born out of the need to streamline the process, SimPYson makes it easier to prepare input files from DFT calculations and analyze results from SIMPSON simulations all within a Python.

## Features 🤌

- **Convert DFT data to SIMPSON input files**: Prepare SIMPSON input files from DFT data (CASTEP, Quantum Espresso, VASP).

- **Read SIMPSON output files**: Load and manipulate NMR data from SIMPSON `.spe`, `.fid`, and `.xreim` files directly in Python for further analysis and visualization.

- **Templates for common experiments**: Use ready-made templates for typical Simpson NMR simulations, currently 90-degree pulse and no-pulse. More soon.

## Documentation 📖

To learn more about simpyson, including some tutorials check the [documentation](https://carlosbornes.github.io/simpyson/).

# Planned Features 🔜

- **Expand number of pulse sequences**: Additional templates for more complex NMR experiments.

- **Expand number of DFT codes**: Improve the support of other DFT codes, suggestions are welcomed.
