Metadata-Version: 2.4
Name: pychemelt
Version: 1.0.6
Summary: Add your description here
Author: Osvaldo Burastero, Florian Vögele
License-Expression: MIT
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: kaleido>=1.0.0
Requires-Dist: lmfit>=1.3.4
Requires-Dist: matplotlib>=3.10.7
Requires-Dist: numdifftools>=0.9.42
Requires-Dist: numpy>=2.3.5
Requires-Dist: openpyxl>=3.1.5
Requires-Dist: pandas>=2.3.3
Requires-Dist: plotly>=6.5.0
Requires-Dist: scipy>=1.16.3
Requires-Dist: xlrd>=2.0.2
Provides-Extra: test
Requires-Dist: pytest>=7.0.0; extra == "test"
Requires-Dist: pytest-cov>=4.0.0; extra == "test"
Provides-Extra: docs
Requires-Dist: Sphinx>=7.0.0; extra == "docs"
Requires-Dist: ipykernel>=6.29.5; extra == "docs"
Requires-Dist: pip>=25.0; extra == "docs"
Requires-Dist: sphinx-rtd-theme>=3.1.0; extra == "docs"
Requires-Dist: sphinx_design>=0.5.0; extra == "docs"
Requires-Dist: numpydoc>=1.6.0; extra == "docs"
Requires-Dist: nbsphinx>=0.9.7; extra == "docs"
Requires-Dist: sphinx_copybutton>=0.5.0; extra == "docs"
Requires-Dist: sphinx-tabs>=3.4.0; extra == "docs"
Provides-Extra: dev
Requires-Dist: pytest>=7.0.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
Requires-Dist: coverage-badge>=1.1.0; extra == "dev"
Requires-Dist: black>=23.0.0; extra == "dev"
Requires-Dist: flake8>=6.0.0; extra == "dev"
Requires-Dist: jupyter>=1.0.0; extra == "dev"
Requires-Dist: notebook>=6.0.0; extra == "dev"
Requires-Dist: ipykernel>=6.29.5; extra == "dev"
Requires-Dist: pip>=25.0; extra == "dev"
Requires-Dist: Sphinx>=7.0.0; extra == "dev"
Requires-Dist: sphinx-rtd-theme>=3.1.0; extra == "dev"
Requires-Dist: sphinx_design>=0.5.0; extra == "dev"
Requires-Dist: numpydoc>=1.6.0; extra == "dev"
Requires-Dist: nbsphinx>=0.9.7; extra == "dev"
Requires-Dist: sphinx_copybutton>=0.5.0; extra == "dev"
Requires-Dist: sphinx-tabs>=3.4.0; extra == "dev"
Dynamic: license-file

# PyCheMelt

[![Tests](https://github.com/osvalB/pychemelt/actions/workflows/ci-cd.yml/badge.svg)](https://github.com/osvalB/pychemelt/actions/workflows/ci-cd.yml)
[![codecov](https://codecov.io/gh/osvalB/pychemelt/graph/badge.svg)](https://codecov.io/gh/osvalB/pychemelt)
[![Documentation](https://img.shields.io/badge/docs-online-blue)](https://osvalb.github.io/pychemelt/)

Welcome to PyCheMelt, a python-package to globally analyse protein denaturation data.

## Features

- **Data Import**: Import differential scanning fluorimetry (DSF) data or circular dichroism (CD) data from various instruments, including Nanotemper (Prometheus and Panta), Unchained Labs (AUNTY and UNCLE), Applied Photophysics (SUPR-DSF and Chirascan), and Jasco instruments.   
- **Thermochemical denaturation of protein monomers**: Fit the melting curves obtained at different denaturant agent concentrations to a thermochemical denaturation model to determine the thermodynamic parameters of protein unfolding, such as the melting temperature (<em>T</em><sub>m</sub>), the change in enthalpy (Δ<em>H</em>), and the change in heat capacity (Δ<em>C</em><sub>p</sub>).
- **Thermal denaturation of oligomers**: Fit the melting curves obtained at different protein concentrations to reversible two-state or three-state unfolding models.

## Install for Users

The recommended way to install PyCheMelt is with [uv](https://docs.astral.sh/uv/):

```bash
uv add pychemelt
```

If you are not using `uv`, install PyCheMelt with pip:

```bash
pip install pychemelt
```

## Examples

Jupyter notebooks with examples of how to use PyChemelt are available at https://github.com/osvalB/pychemelt_analyses


## Install from Source - Development

Run these commands in your shell:

```bash
git clone https://github.com/osvalB/pychemelt.git
cd pychemelt
uv sync --extra dev
```

Verify the installation:

```bash
uv run pytest -v
```

## Authors

- Osvaldo Burastero
- Florian Vögele

## License

PyCheMelt is distributed under the MIT License. See [LICENSE](LICENSE).
