Metadata-Version: 2.4
Name: pkynetics
Version: 0.4.8
Summary: A comprehensive library for thermal analysis kinetic methods
Project-URL: Homepage, https://github.com/PPeitsch/pkynetics
Project-URL: Documentation, https://pkynetics.readthedocs.io/
Project-URL: Repository, https://github.com/PPeitsch/pkynetics.git
Project-URL: Bug Tracker, https://github.com/PPeitsch/pkynetics/issues
Project-URL: Changelog, https://github.com/PPeitsch/pkynetics/blob/main/CHANGELOG.md
Author-email: Pablo Peitsch <pablo.peitsch@gmail.com>
License: MIT License
        
        Copyright (c) 2024 PPeitsch
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: dilatometry,dsc,kinetics,thermal-analysis,thermogravimetry
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Framework :: Pytest
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Chemistry
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Typing :: Typed
Requires-Python: >=3.9
Requires-Dist: chardet>=5.0.0
Requires-Dist: matplotlib>=3.7.5
Requires-Dist: numpy>=1.24.3
Requires-Dist: pandas>=2.0.3
Requires-Dist: scikit-learn>=0.24.0
Requires-Dist: scipy>=1.10.1
Requires-Dist: seaborn>=0.11.0
Requires-Dist: statsmodels>=0.14.1
Provides-Extra: dev
Requires-Dist: black>=23.0.0; extra == 'dev'
Requires-Dist: isort>=5.0.0; extra == 'dev'
Requires-Dist: mypy>=1.0.0; extra == 'dev'
Requires-Dist: pandas-stubs>=2.0.0; extra == 'dev'
Requires-Dist: pytest-cov>=4.1.0; extra == 'dev'
Requires-Dist: pytest<8.0.0,>=6.0.0; extra == 'dev'
Requires-Dist: sphinx<6.0.0,>=4.0.0; extra == 'dev'
Description-Content-Type: text/markdown

# Pkynetics

[![PyPI version](https://badge.fury.io/py/pkynetics.svg)](https://badge.fury.io/py/pkynetics)
[![Python Versions](https://img.shields.io/pypi/pyversions/pkynetics.svg)](https://pypi.org/project/pkynetics/)
[![Documentation Status](https://readthedocs.org/projects/pkynetics/badge/?version=latest)](https://pkynetics.readthedocs.io/en/latest/?badge=latest)
[![Tests](https://github.com/PPeitsch/pkynetics/workflows/Test%20and%20Publish/badge.svg)](https://github.com/PPeitsch/pkynetics/actions/workflows/test-and-publish.yaml)
[![Coverage](https://codecov.io/gh/PPeitsch/pkynetics/branch/main/graph/badge.svg)](https://codecov.io/gh/PPeitsch/pkynetics)
[![License](https://img.shields.io/pypi/l/pkynetics.svg)](https://github.com/PPeitsch/pkynetics/blob/main/LICENSE)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](.github/CODE_OF_CONDUCT.md)

A Python library for thermal analysis kinetic methods, providing tools for data preprocessing, kinetic analysis, and result visualization.

## Features

### Data Import
- Support for thermal analysis instruments:
- Flexible custom importer for non-standard formats
- Automatic manufacturer detection
- Comprehensive data validation

### Analysis Methods
- Model-fitting methods:
  - Johnson-Mehl-Avrami-Kolmogorov (JMAK)
  - Kissinger
  - Coats-Redfern
  - Freeman-Carroll
  - Horowitz-Metzger
- Model-Free methods:
  - Friedman method
  - Kissinger-Akahira-Sunose (KAS)
  - Ozawa-Flynn-Wall (OFW)
- Dilatometry analysis
- DSC analysis
- Data preprocessing capabilities
- Error handling and validation

### Visualization
- Comprehensive plotting functions for:
  - Kinetic analysis results
  - Dilatometry data
  - Transformation analysis
  - Custom plot styling options
- Interactive visualization capabilities

## Installation

Pkynetics requires Python 3.9 or later. Install using pip:

```bash
pip install pkynetics
```

For development installation:

```bash
git clone https://github.com/PPeitsch/pkynetics.git
cd pkynetics
pip install -e .[dev]
```

For detailed installation instructions and requirements, see our [Installation Guide](https://pkynetics.readthedocs.io/en/latest/installation.html).

## Documentation

Complete documentation is available at [pkynetics.readthedocs.io](https://pkynetics.readthedocs.io/), including:
- Detailed API reference
- Usage examples
- Method descriptions
- Best practices

## Contributing

We welcome contributions! Please read our:
- [Contributing Guidelines](.github/CONTRIBUTING.md)
- [Code of Conduct](.github/CODE_OF_CONDUCT.md)

## Security

For vulnerability reports, please review our [Security Policy](.github/SECURITY.md).

## Change Log

See [CHANGELOG.md](CHANGELOG.md) for a list of changes and version updates.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Citing Pkynetics

If you use Pkynetics in your research, please cite it as:

```bibtex
@software{pkynetics2025,
  author = {Pablo Peitsch},
  title = {Pkynetics: A Python Library for Thermal Analysis Kinetic Methods},
  year = {2025},
  publisher = {GitHub},
  url = {https://github.com/PPeitsch/pkynetics}
}
