pkynetics


Namepkynetics JSON
Version 0.3.4 PyPI version JSON
download
home_pageNone
SummaryA comprehensive library for thermal analysis kinetic methods
upload_time2025-03-11 21:43:08
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseMIT 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.
keywords dilatometry dsc kinetics thermal-analysis thermogravimetry
VCS
bugtrack_url
requirements numpy matplotlib setuptools pandas scipy statsmodels scikit-learn seaborn pytest pylint
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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
- 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{pkynetics2024,
  author = {Pablo Peitsch},
  title = {Pkynetics: A Python Library for Thermal Analysis Kinetic Methods},
  year = {2024},
  publisher = {GitHub},
  url = {https://github.com/PPeitsch/pkynetics}
}
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pkynetics",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "dilatometry, dsc, kinetics, thermal-analysis, thermogravimetry",
    "author": null,
    "author_email": "Pablo Peitsch <pablo.peitsch@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/ea/77/c2ac41ffb47ff06f0863e853b0a2fc0a6fff15d61f3f40ed05eb502e502d/pkynetics-0.3.4.tar.gz",
    "platform": null,
    "description": "# Pkynetics\n\n[![PyPI version](https://badge.fury.io/py/pkynetics.svg)](https://badge.fury.io/py/pkynetics)\n[![Python Versions](https://img.shields.io/pypi/pyversions/pkynetics.svg)](https://pypi.org/project/pkynetics/)\n[![Documentation Status](https://readthedocs.org/projects/pkynetics/badge/?version=latest)](https://pkynetics.readthedocs.io/en/latest/?badge=latest)\n[![Tests](https://github.com/PPeitsch/pkynetics/workflows/Test%20and%20Publish/badge.svg)](https://github.com/PPeitsch/pkynetics/actions/workflows/test-and-publish.yaml)\n[![Coverage](https://codecov.io/gh/PPeitsch/pkynetics/branch/main/graph/badge.svg)](https://codecov.io/gh/PPeitsch/pkynetics)\n[![License](https://img.shields.io/pypi/l/pkynetics.svg)](https://github.com/PPeitsch/pkynetics/blob/main/LICENSE)\n[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](.github/CODE_OF_CONDUCT.md)\n\nA Python library for thermal analysis kinetic methods, providing tools for data preprocessing, kinetic analysis, and result visualization.\n\n## Features\n\n### Data Import\n- Support for thermal analysis instruments:\n- Flexible custom importer for non-standard formats\n- Automatic manufacturer detection\n- Comprehensive data validation\n\n### Analysis Methods\n- Model-fitting methods:\n  - Johnson-Mehl-Avrami-Kolmogorov (JMAK)\n  - Kissinger\n  - Coats-Redfern\n  - Freeman-Carroll\n  - Horowitz-Metzger\n- Model-Free methods:\n  - Friedman method\n  - Kissinger-Akahira-Sunose (KAS)\n  - Ozawa-Flynn-Wall (OFW)\n- Dilatometry analysis\n- Data preprocessing capabilities\n- Error handling and validation\n\n### Visualization\n- Comprehensive plotting functions for:\n  - Kinetic analysis results\n  - Dilatometry data\n  - Transformation analysis\n  - Custom plot styling options\n- Interactive visualization capabilities\n\n## Installation\n\nPkynetics requires Python 3.9 or later. Install using pip:\n\n```bash\npip install pkynetics\n```\n\nFor development installation:\n\n```bash\ngit clone https://github.com/PPeitsch/pkynetics.git\ncd pkynetics\npip install -e .[dev]\n```\n\nFor detailed installation instructions and requirements, see our [Installation Guide](https://pkynetics.readthedocs.io/en/latest/installation.html).\n\n## Documentation\n\nComplete documentation is available at [pkynetics.readthedocs.io](https://pkynetics.readthedocs.io/), including:\n- Detailed API reference\n- Usage examples\n- Method descriptions\n- Best practices\n\n## Contributing\n\nWe welcome contributions! Please read our:\n- [Contributing Guidelines](.github/CONTRIBUTING.md)\n- [Code of Conduct](.github/CODE_OF_CONDUCT.md)\n\n## Security\n\nFor vulnerability reports, please review our [Security Policy](.github/SECURITY.md).\n\n## Change Log\n\nSee [CHANGELOG.md](CHANGELOG.md) for a list of changes and version updates.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Citing Pkynetics\n\nIf you use Pkynetics in your research, please cite it as:\n\n```bibtex\n@software{pkynetics2024,\n  author = {Pablo Peitsch},\n  title = {Pkynetics: A Python Library for Thermal Analysis Kinetic Methods},\n  year = {2024},\n  publisher = {GitHub},\n  url = {https://github.com/PPeitsch/pkynetics}\n}\n```\n",
    "bugtrack_url": null,
    "license": "MIT License\n        \n        Copyright (c) 2024 PPeitsch\n        \n        Permission is hereby granted, free of charge, to any person obtaining a copy\n        of this software and associated documentation files (the \"Software\"), to deal\n        in the Software without restriction, including without limitation the rights\n        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n        copies of the Software, and to permit persons to whom the Software is\n        furnished to do so, subject to the following conditions:\n        \n        The above copyright notice and this permission notice shall be included in all\n        copies or substantial portions of the Software.\n        \n        THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n        SOFTWARE.",
    "summary": "A comprehensive library for thermal analysis kinetic methods",
    "version": "0.3.4",
    "project_urls": {
        "Bug Tracker": "https://github.com/PPeitsch/pkynetics/issues",
        "Changelog": "https://github.com/PPeitsch/pkynetics/blob/main/CHANGELOG.md",
        "Documentation": "https://pkynetics.readthedocs.io/",
        "Homepage": "https://github.com/PPeitsch/pkynetics",
        "Repository": "https://github.com/PPeitsch/pkynetics.git"
    },
    "split_keywords": [
        "dilatometry",
        " dsc",
        " kinetics",
        " thermal-analysis",
        " thermogravimetry"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "634d092897ddd9e9bf5489953abadac4baa35463fb35653406c67399f586a614",
                "md5": "c9a6d166ce843f26172df58bef488ab5",
                "sha256": "fe2800105fdf6508d4ae20f9d422bf188de5f85c28b866009d9134aa9461ae20"
            },
            "downloads": -1,
            "filename": "pkynetics-0.3.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c9a6d166ce843f26172df58bef488ab5",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 397899,
            "upload_time": "2025-03-11T21:43:07",
            "upload_time_iso_8601": "2025-03-11T21:43:07.235435Z",
            "url": "https://files.pythonhosted.org/packages/63/4d/092897ddd9e9bf5489953abadac4baa35463fb35653406c67399f586a614/pkynetics-0.3.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "ea77c2ac41ffb47ff06f0863e853b0a2fc0a6fff15d61f3f40ed05eb502e502d",
                "md5": "27daf46a010d3f907698e009c329b2d8",
                "sha256": "705062645bba7858c60e8dd797c97b1ec98028210ba477d3364301b2839211e6"
            },
            "downloads": -1,
            "filename": "pkynetics-0.3.4.tar.gz",
            "has_sig": false,
            "md5_digest": "27daf46a010d3f907698e009c329b2d8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 5439,
            "upload_time": "2025-03-11T21:43:08",
            "upload_time_iso_8601": "2025-03-11T21:43:08.990617Z",
            "url": "https://files.pythonhosted.org/packages/ea/77/c2ac41ffb47ff06f0863e853b0a2fc0a6fff15d61f3f40ed05eb502e502d/pkynetics-0.3.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-03-11 21:43:08",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "PPeitsch",
    "github_project": "pkynetics",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "numpy",
            "specs": [
                [
                    "~=",
                    "1.24.3"
                ]
            ]
        },
        {
            "name": "matplotlib",
            "specs": [
                [
                    "~=",
                    "3.7.5"
                ]
            ]
        },
        {
            "name": "setuptools",
            "specs": [
                [
                    "~=",
                    "68.2.0"
                ]
            ]
        },
        {
            "name": "pandas",
            "specs": [
                [
                    "~=",
                    "2.0.3"
                ]
            ]
        },
        {
            "name": "scipy",
            "specs": [
                [
                    "~=",
                    "1.10.1"
                ]
            ]
        },
        {
            "name": "statsmodels",
            "specs": [
                [
                    "~=",
                    "0.14.1"
                ]
            ]
        },
        {
            "name": "scikit-learn",
            "specs": [
                [
                    ">=",
                    "0.24.0"
                ]
            ]
        },
        {
            "name": "seaborn",
            "specs": [
                [
                    ">=",
                    "0.11.0"
                ]
            ]
        },
        {
            "name": "pytest",
            "specs": [
                [
                    ">=",
                    "6.2.0"
                ]
            ]
        },
        {
            "name": "pylint",
            "specs": [
                [
                    ">=",
                    "2.7.0"
                ]
            ]
        }
    ],
    "lcname": "pkynetics"
}
        
Elapsed time: 1.37477s