pkynetics 0.2.3__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- pkynetics-0.2.3/.gitignore +164 -0
- pkynetics-0.2.3/LICENSE +21 -0
- pkynetics-0.2.3/PKG-INFO +167 -0
- pkynetics-0.2.3/README.md +100 -0
- pkynetics-0.2.3/pyproject.toml +118 -0
- pkynetics-0.2.3/src/pkynetics/_version.py +4 -0
- pkynetics-0.2.3/src/pkynetics/py.typed +0 -0
|
@@ -0,0 +1,164 @@
|
|
|
1
|
+
### Python template
|
|
2
|
+
# Byte-compiled / optimized / DLL files
|
|
3
|
+
__pycache__/
|
|
4
|
+
*.py[cod]
|
|
5
|
+
*$py.class
|
|
6
|
+
|
|
7
|
+
# C extensions
|
|
8
|
+
*.so
|
|
9
|
+
|
|
10
|
+
# Distribution / packaging
|
|
11
|
+
.Python
|
|
12
|
+
build/
|
|
13
|
+
develop-eggs/
|
|
14
|
+
dist/
|
|
15
|
+
downloads/
|
|
16
|
+
eggs/
|
|
17
|
+
.eggs/
|
|
18
|
+
lib/
|
|
19
|
+
lib64/
|
|
20
|
+
parts/
|
|
21
|
+
sdist/
|
|
22
|
+
var/
|
|
23
|
+
wheels/
|
|
24
|
+
share/python-wheels/
|
|
25
|
+
*.egg-info/
|
|
26
|
+
.installed.cfg
|
|
27
|
+
*.egg
|
|
28
|
+
MANIFEST
|
|
29
|
+
_version.py
|
|
30
|
+
|
|
31
|
+
# PyInstaller
|
|
32
|
+
# Usually these files are written by a python script from a template
|
|
33
|
+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
|
34
|
+
*.manifest
|
|
35
|
+
*.spec
|
|
36
|
+
|
|
37
|
+
# Installer logs
|
|
38
|
+
pip-log.txt
|
|
39
|
+
pip-delete-this-directory.txt
|
|
40
|
+
|
|
41
|
+
# Unit test / coverage reports
|
|
42
|
+
htmlcov/
|
|
43
|
+
.tox/
|
|
44
|
+
.nox/
|
|
45
|
+
.coverage
|
|
46
|
+
.coverage.*
|
|
47
|
+
.cache
|
|
48
|
+
nosetests.xml
|
|
49
|
+
coverage.xml
|
|
50
|
+
*.cover
|
|
51
|
+
*.py,cover
|
|
52
|
+
.hypothesis/
|
|
53
|
+
.pytest_cache/
|
|
54
|
+
cover/
|
|
55
|
+
|
|
56
|
+
# Translations
|
|
57
|
+
*.mo
|
|
58
|
+
*.pot
|
|
59
|
+
|
|
60
|
+
# Django stuff:
|
|
61
|
+
*.log
|
|
62
|
+
local_settings.py
|
|
63
|
+
db.sqlite3
|
|
64
|
+
db.sqlite3-journal
|
|
65
|
+
|
|
66
|
+
# Flask stuff:
|
|
67
|
+
instance/
|
|
68
|
+
.webassets-cache
|
|
69
|
+
|
|
70
|
+
# Scrapy stuff:
|
|
71
|
+
.scrapy
|
|
72
|
+
|
|
73
|
+
# Sphinx documentation
|
|
74
|
+
docs/_build/
|
|
75
|
+
|
|
76
|
+
# PyBuilder
|
|
77
|
+
.pybuilder/
|
|
78
|
+
target/
|
|
79
|
+
|
|
80
|
+
# Jupyter Notebook
|
|
81
|
+
.ipynb_checkpoints
|
|
82
|
+
|
|
83
|
+
# IPython
|
|
84
|
+
profile_default/
|
|
85
|
+
ipython_config.py
|
|
86
|
+
|
|
87
|
+
# pyenv
|
|
88
|
+
# For a library or package, you might want to ignore these files since the code is
|
|
89
|
+
# intended to run in multiple environments; otherwise, check them in:
|
|
90
|
+
# .python-version
|
|
91
|
+
|
|
92
|
+
# pipenv
|
|
93
|
+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
|
94
|
+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
|
|
95
|
+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
|
|
96
|
+
# install all needed dependencies.
|
|
97
|
+
#Pipfile.lock
|
|
98
|
+
|
|
99
|
+
# poetry
|
|
100
|
+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
|
|
101
|
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
102
|
+
# commonly ignored for libraries.
|
|
103
|
+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
|
|
104
|
+
#poetry.lock
|
|
105
|
+
|
|
106
|
+
# pdm
|
|
107
|
+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
|
|
108
|
+
#pdm.lock
|
|
109
|
+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
|
|
110
|
+
# in version control.
|
|
111
|
+
# https://pdm.fming.dev/#use-with-ide
|
|
112
|
+
.pdm.toml
|
|
113
|
+
|
|
114
|
+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
|
|
115
|
+
__pypackages__/
|
|
116
|
+
|
|
117
|
+
# Celery stuff
|
|
118
|
+
celerybeat-schedule
|
|
119
|
+
celerybeat.pid
|
|
120
|
+
|
|
121
|
+
# SageMath parsed files
|
|
122
|
+
*.sage.py
|
|
123
|
+
|
|
124
|
+
# Environments
|
|
125
|
+
.env
|
|
126
|
+
.venv
|
|
127
|
+
.venv39
|
|
128
|
+
env/
|
|
129
|
+
venv/
|
|
130
|
+
ENV/
|
|
131
|
+
env.bak/
|
|
132
|
+
venv.bak/
|
|
133
|
+
|
|
134
|
+
# Spyder project settings
|
|
135
|
+
.spyderproject
|
|
136
|
+
.spyproject
|
|
137
|
+
|
|
138
|
+
# Rope project settings
|
|
139
|
+
.ropeproject
|
|
140
|
+
|
|
141
|
+
# mkdocs documentation
|
|
142
|
+
/site
|
|
143
|
+
|
|
144
|
+
# mypy
|
|
145
|
+
.mypy_cache/
|
|
146
|
+
.dmypy.json
|
|
147
|
+
dmypy.json
|
|
148
|
+
|
|
149
|
+
# Pyre type checker
|
|
150
|
+
.pyre/
|
|
151
|
+
|
|
152
|
+
# pytype static type analyzer
|
|
153
|
+
.pytype/
|
|
154
|
+
|
|
155
|
+
# Cython debug symbols
|
|
156
|
+
cython_debug/
|
|
157
|
+
|
|
158
|
+
# PyCharm
|
|
159
|
+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
|
|
160
|
+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
|
|
161
|
+
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
|
162
|
+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
|
163
|
+
.idea/
|
|
164
|
+
|
pkynetics-0.2.3/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2024 PPeitsch
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
pkynetics-0.2.3/PKG-INFO
ADDED
|
@@ -0,0 +1,167 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: pkynetics
|
|
3
|
+
Version: 0.2.3
|
|
4
|
+
Summary: A comprehensive library for thermal analysis kinetic methods
|
|
5
|
+
Project-URL: Homepage, https://github.com/PPeitsch/pkynetics
|
|
6
|
+
Project-URL: Documentation, https://pkynetics.readthedocs.io/
|
|
7
|
+
Project-URL: Repository, https://github.com/PPeitsch/pkynetics.git
|
|
8
|
+
Project-URL: Bug Tracker, https://github.com/PPeitsch/pkynetics/issues
|
|
9
|
+
Project-URL: Changelog, https://github.com/PPeitsch/pkynetics/blob/main/CHANGELOG.md
|
|
10
|
+
Author-email: Pablo Peitsch <pablo.peitsch@gmail.com>
|
|
11
|
+
License: MIT License
|
|
12
|
+
|
|
13
|
+
Copyright (c) 2024 PPeitsch
|
|
14
|
+
|
|
15
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
16
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
17
|
+
in the Software without restriction, including without limitation the rights
|
|
18
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
19
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
20
|
+
furnished to do so, subject to the following conditions:
|
|
21
|
+
|
|
22
|
+
The above copyright notice and this permission notice shall be included in all
|
|
23
|
+
copies or substantial portions of the Software.
|
|
24
|
+
|
|
25
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
26
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
27
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
28
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
29
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
30
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
31
|
+
SOFTWARE.
|
|
32
|
+
License-File: LICENSE
|
|
33
|
+
Keywords: dilatometry,dsc,kinetics,thermal-analysis,thermogravimetry
|
|
34
|
+
Classifier: Development Status :: 3 - Alpha
|
|
35
|
+
Classifier: Environment :: Console
|
|
36
|
+
Classifier: Framework :: Pytest
|
|
37
|
+
Classifier: Intended Audience :: Science/Research
|
|
38
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
39
|
+
Classifier: Natural Language :: English
|
|
40
|
+
Classifier: Programming Language :: Python :: 3
|
|
41
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
42
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
43
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
44
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
45
|
+
Classifier: Topic :: Scientific/Engineering
|
|
46
|
+
Classifier: Topic :: Scientific/Engineering :: Chemistry
|
|
47
|
+
Classifier: Topic :: Scientific/Engineering :: Physics
|
|
48
|
+
Classifier: Typing :: Typed
|
|
49
|
+
Requires-Python: >=3.9
|
|
50
|
+
Requires-Dist: chardet>=5.0.0
|
|
51
|
+
Requires-Dist: matplotlib~=3.7.5
|
|
52
|
+
Requires-Dist: numpy~=1.24.3
|
|
53
|
+
Requires-Dist: pandas~=2.0.3
|
|
54
|
+
Requires-Dist: scikit-learn>=0.24.0
|
|
55
|
+
Requires-Dist: scipy~=1.10.1
|
|
56
|
+
Requires-Dist: seaborn>=0.11.0
|
|
57
|
+
Requires-Dist: statsmodels~=0.14.1
|
|
58
|
+
Provides-Extra: dev
|
|
59
|
+
Requires-Dist: black>=23.0.0; extra == 'dev'
|
|
60
|
+
Requires-Dist: isort>=5.0.0; extra == 'dev'
|
|
61
|
+
Requires-Dist: mypy>=1.0.0; extra == 'dev'
|
|
62
|
+
Requires-Dist: pandas-stubs>=2.0.0; extra == 'dev'
|
|
63
|
+
Requires-Dist: pytest-cov>=4.1.0; extra == 'dev'
|
|
64
|
+
Requires-Dist: pytest<8.0.0,>=6.0.0; extra == 'dev'
|
|
65
|
+
Requires-Dist: sphinx<6.0.0,>=4.0.0; extra == 'dev'
|
|
66
|
+
Description-Content-Type: text/markdown
|
|
67
|
+
|
|
68
|
+
# Pkynetics
|
|
69
|
+
|
|
70
|
+
[](https://badge.fury.io/py/pkynetics)
|
|
71
|
+
[](https://pypi.org/project/pkynetics/)
|
|
72
|
+
[](https://pkynetics.readthedocs.io/en/latest/?badge=latest)
|
|
73
|
+
[](https://github.com/PPeitsch/pkynetics/actions/workflows/test-and-publish.yaml)
|
|
74
|
+
[](https://codecov.io/gh/PPeitsch/pkynetics)
|
|
75
|
+
[](https://github.com/PPeitsch/pkynetics/blob/main/LICENSE)
|
|
76
|
+
[](.github/CODE_OF_CONDUCT.md)
|
|
77
|
+
|
|
78
|
+
A Python library for thermal analysis kinetic methods, providing tools for data preprocessing, kinetic analysis, and result visualization.
|
|
79
|
+
|
|
80
|
+
## Features
|
|
81
|
+
|
|
82
|
+
### Data Import
|
|
83
|
+
- Support for thermal analysis instruments:
|
|
84
|
+
- Flexible custom importer for non-standard formats
|
|
85
|
+
- Automatic manufacturer detection
|
|
86
|
+
- Comprehensive data validation
|
|
87
|
+
|
|
88
|
+
### Analysis Methods
|
|
89
|
+
- Model-fitting methods:
|
|
90
|
+
- Johnson-Mehl-Avrami-Kolmogorov (JMAK)
|
|
91
|
+
- Kissinger
|
|
92
|
+
- Coats-Redfern
|
|
93
|
+
- Freeman-Carroll
|
|
94
|
+
- Horowitz-Metzger
|
|
95
|
+
- Model-Free methods:
|
|
96
|
+
- Friedman method
|
|
97
|
+
- Kissinger-Akahira-Sunose (KAS)
|
|
98
|
+
- Ozawa-Flynn-Wall (OFW)
|
|
99
|
+
- Dilatometry analysis
|
|
100
|
+
- Data preprocessing capabilities
|
|
101
|
+
- Error handling and validation
|
|
102
|
+
|
|
103
|
+
### Visualization
|
|
104
|
+
- Comprehensive plotting functions for:
|
|
105
|
+
- Kinetic analysis results
|
|
106
|
+
- Dilatometry data
|
|
107
|
+
- Transformation analysis
|
|
108
|
+
- Custom plot styling options
|
|
109
|
+
- Interactive visualization capabilities
|
|
110
|
+
|
|
111
|
+
## Installation
|
|
112
|
+
|
|
113
|
+
Pkynetics requires Python 3.9 or later. Install using pip:
|
|
114
|
+
|
|
115
|
+
```bash
|
|
116
|
+
pip install pkynetics
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
For development installation:
|
|
120
|
+
|
|
121
|
+
```bash
|
|
122
|
+
git clone https://github.com/PPeitsch/pkynetics.git
|
|
123
|
+
cd pkynetics
|
|
124
|
+
pip install -e .[dev]
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
For detailed installation instructions and requirements, see our [Installation Guide](https://pkynetics.readthedocs.io/en/latest/installation.html).
|
|
128
|
+
|
|
129
|
+
## Documentation
|
|
130
|
+
|
|
131
|
+
Complete documentation is available at [pkynetics.readthedocs.io](https://pkynetics.readthedocs.io/), including:
|
|
132
|
+
- Detailed API reference
|
|
133
|
+
- Usage examples
|
|
134
|
+
- Method descriptions
|
|
135
|
+
- Best practices
|
|
136
|
+
|
|
137
|
+
## Contributing
|
|
138
|
+
|
|
139
|
+
We welcome contributions! Please read our:
|
|
140
|
+
- [Contributing Guidelines](.github/CONTRIBUTING.md)
|
|
141
|
+
- [Code of Conduct](.github/CODE_OF_CONDUCT.md)
|
|
142
|
+
|
|
143
|
+
## Security
|
|
144
|
+
|
|
145
|
+
For vulnerability reports, please review our [Security Policy](.github/SECURITY.md).
|
|
146
|
+
|
|
147
|
+
## Change Log
|
|
148
|
+
|
|
149
|
+
See [CHANGELOG.md](CHANGELOG.md) for a list of changes and version updates.
|
|
150
|
+
|
|
151
|
+
## License
|
|
152
|
+
|
|
153
|
+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
|
154
|
+
|
|
155
|
+
## Citing Pkynetics
|
|
156
|
+
|
|
157
|
+
If you use Pkynetics in your research, please cite it as:
|
|
158
|
+
|
|
159
|
+
```bibtex
|
|
160
|
+
@software{pkynetics2024,
|
|
161
|
+
author = {Pablo Peitsch},
|
|
162
|
+
title = {Pkynetics: A Python Library for Thermal Analysis Kinetic Methods},
|
|
163
|
+
year = {2024},
|
|
164
|
+
publisher = {GitHub},
|
|
165
|
+
url = {https://github.com/PPeitsch/pkynetics}
|
|
166
|
+
}
|
|
167
|
+
```
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
# Pkynetics
|
|
2
|
+
|
|
3
|
+
[](https://badge.fury.io/py/pkynetics)
|
|
4
|
+
[](https://pypi.org/project/pkynetics/)
|
|
5
|
+
[](https://pkynetics.readthedocs.io/en/latest/?badge=latest)
|
|
6
|
+
[](https://github.com/PPeitsch/pkynetics/actions/workflows/test-and-publish.yaml)
|
|
7
|
+
[](https://codecov.io/gh/PPeitsch/pkynetics)
|
|
8
|
+
[](https://github.com/PPeitsch/pkynetics/blob/main/LICENSE)
|
|
9
|
+
[](.github/CODE_OF_CONDUCT.md)
|
|
10
|
+
|
|
11
|
+
A Python library for thermal analysis kinetic methods, providing tools for data preprocessing, kinetic analysis, and result visualization.
|
|
12
|
+
|
|
13
|
+
## Features
|
|
14
|
+
|
|
15
|
+
### Data Import
|
|
16
|
+
- Support for thermal analysis instruments:
|
|
17
|
+
- Flexible custom importer for non-standard formats
|
|
18
|
+
- Automatic manufacturer detection
|
|
19
|
+
- Comprehensive data validation
|
|
20
|
+
|
|
21
|
+
### Analysis Methods
|
|
22
|
+
- Model-fitting methods:
|
|
23
|
+
- Johnson-Mehl-Avrami-Kolmogorov (JMAK)
|
|
24
|
+
- Kissinger
|
|
25
|
+
- Coats-Redfern
|
|
26
|
+
- Freeman-Carroll
|
|
27
|
+
- Horowitz-Metzger
|
|
28
|
+
- Model-Free methods:
|
|
29
|
+
- Friedman method
|
|
30
|
+
- Kissinger-Akahira-Sunose (KAS)
|
|
31
|
+
- Ozawa-Flynn-Wall (OFW)
|
|
32
|
+
- Dilatometry analysis
|
|
33
|
+
- Data preprocessing capabilities
|
|
34
|
+
- Error handling and validation
|
|
35
|
+
|
|
36
|
+
### Visualization
|
|
37
|
+
- Comprehensive plotting functions for:
|
|
38
|
+
- Kinetic analysis results
|
|
39
|
+
- Dilatometry data
|
|
40
|
+
- Transformation analysis
|
|
41
|
+
- Custom plot styling options
|
|
42
|
+
- Interactive visualization capabilities
|
|
43
|
+
|
|
44
|
+
## Installation
|
|
45
|
+
|
|
46
|
+
Pkynetics requires Python 3.9 or later. Install using pip:
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
pip install pkynetics
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
For development installation:
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
git clone https://github.com/PPeitsch/pkynetics.git
|
|
56
|
+
cd pkynetics
|
|
57
|
+
pip install -e .[dev]
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
For detailed installation instructions and requirements, see our [Installation Guide](https://pkynetics.readthedocs.io/en/latest/installation.html).
|
|
61
|
+
|
|
62
|
+
## Documentation
|
|
63
|
+
|
|
64
|
+
Complete documentation is available at [pkynetics.readthedocs.io](https://pkynetics.readthedocs.io/), including:
|
|
65
|
+
- Detailed API reference
|
|
66
|
+
- Usage examples
|
|
67
|
+
- Method descriptions
|
|
68
|
+
- Best practices
|
|
69
|
+
|
|
70
|
+
## Contributing
|
|
71
|
+
|
|
72
|
+
We welcome contributions! Please read our:
|
|
73
|
+
- [Contributing Guidelines](.github/CONTRIBUTING.md)
|
|
74
|
+
- [Code of Conduct](.github/CODE_OF_CONDUCT.md)
|
|
75
|
+
|
|
76
|
+
## Security
|
|
77
|
+
|
|
78
|
+
For vulnerability reports, please review our [Security Policy](.github/SECURITY.md).
|
|
79
|
+
|
|
80
|
+
## Change Log
|
|
81
|
+
|
|
82
|
+
See [CHANGELOG.md](CHANGELOG.md) for a list of changes and version updates.
|
|
83
|
+
|
|
84
|
+
## License
|
|
85
|
+
|
|
86
|
+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
|
87
|
+
|
|
88
|
+
## Citing Pkynetics
|
|
89
|
+
|
|
90
|
+
If you use Pkynetics in your research, please cite it as:
|
|
91
|
+
|
|
92
|
+
```bibtex
|
|
93
|
+
@software{pkynetics2024,
|
|
94
|
+
author = {Pablo Peitsch},
|
|
95
|
+
title = {Pkynetics: A Python Library for Thermal Analysis Kinetic Methods},
|
|
96
|
+
year = {2024},
|
|
97
|
+
publisher = {GitHub},
|
|
98
|
+
url = {https://github.com/PPeitsch/pkynetics}
|
|
99
|
+
}
|
|
100
|
+
```
|
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["hatchling"]
|
|
3
|
+
build-backend = "hatchling.build"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "pkynetics"
|
|
7
|
+
dynamic = ["version"]
|
|
8
|
+
description = "A comprehensive library for thermal analysis kinetic methods"
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
authors = [
|
|
11
|
+
{ name = "Pablo Peitsch", email = "pablo.peitsch@gmail.com" },
|
|
12
|
+
]
|
|
13
|
+
license = { file = "LICENSE" }
|
|
14
|
+
classifiers = [
|
|
15
|
+
"Development Status :: 3 - Alpha",
|
|
16
|
+
"Intended Audience :: Science/Research",
|
|
17
|
+
"License :: OSI Approved :: MIT License",
|
|
18
|
+
"Programming Language :: Python :: 3",
|
|
19
|
+
"Programming Language :: Python :: 3.9",
|
|
20
|
+
"Programming Language :: Python :: 3.10",
|
|
21
|
+
"Programming Language :: Python :: 3.11",
|
|
22
|
+
"Programming Language :: Python :: 3 :: Only",
|
|
23
|
+
"Framework :: Pytest",
|
|
24
|
+
"Topic :: Scientific/Engineering",
|
|
25
|
+
"Topic :: Scientific/Engineering :: Chemistry",
|
|
26
|
+
"Topic :: Scientific/Engineering :: Physics",
|
|
27
|
+
"Natural Language :: English",
|
|
28
|
+
"Environment :: Console",
|
|
29
|
+
"Typing :: Typed",
|
|
30
|
+
]
|
|
31
|
+
keywords = ["thermal-analysis", "kinetics", "thermogravimetry", "dsc", "dilatometry"]
|
|
32
|
+
dependencies = [
|
|
33
|
+
"numpy~=1.24.3",
|
|
34
|
+
"matplotlib~=3.7.5",
|
|
35
|
+
"pandas~=2.0.3",
|
|
36
|
+
"scipy~=1.10.1",
|
|
37
|
+
"statsmodels~=0.14.1",
|
|
38
|
+
"scikit-learn>=0.24.0",
|
|
39
|
+
"seaborn>=0.11.0",
|
|
40
|
+
"chardet>=5.0.0",
|
|
41
|
+
]
|
|
42
|
+
requires-python = ">=3.9"
|
|
43
|
+
|
|
44
|
+
[project.optional-dependencies]
|
|
45
|
+
dev = [
|
|
46
|
+
"pytest>=6.0.0,<8.0.0",
|
|
47
|
+
"pytest-cov>=4.1.0",
|
|
48
|
+
"black>=23.0.0",
|
|
49
|
+
"isort>=5.0.0",
|
|
50
|
+
"mypy>=1.0.0",
|
|
51
|
+
"sphinx>=4.0.0,<6.0.0",
|
|
52
|
+
"pandas-stubs>=2.0.0",
|
|
53
|
+
]
|
|
54
|
+
|
|
55
|
+
[project.urls]
|
|
56
|
+
Homepage = "https://github.com/PPeitsch/pkynetics"
|
|
57
|
+
Documentation = "https://pkynetics.readthedocs.io/"
|
|
58
|
+
Repository = "https://github.com/PPeitsch/pkynetics.git"
|
|
59
|
+
"Bug Tracker" = "https://github.com/PPeitsch/pkynetics/issues"
|
|
60
|
+
Changelog = "https://github.com/PPeitsch/pkynetics/blob/main/CHANGELOG.md"
|
|
61
|
+
|
|
62
|
+
[tool.hatch.build]
|
|
63
|
+
include = [
|
|
64
|
+
"src/pkynetics/py.typed"
|
|
65
|
+
]
|
|
66
|
+
|
|
67
|
+
[tool.hatch.version]
|
|
68
|
+
path = "src/pkynetics/__about__.py"
|
|
69
|
+
|
|
70
|
+
[tool.hatch.build.hooks.version]
|
|
71
|
+
path = "src/pkynetics/_version.py"
|
|
72
|
+
|
|
73
|
+
[tool.hatch.build.targets.wheel]
|
|
74
|
+
packages = ["src/pkynetics"]
|
|
75
|
+
include = ["py.typed"]
|
|
76
|
+
|
|
77
|
+
[tool.hatch.build.targets.sdist]
|
|
78
|
+
include = ["src/pkynetics/py.typed"]
|
|
79
|
+
|
|
80
|
+
[tool.black]
|
|
81
|
+
line-length = 88
|
|
82
|
+
target-version = ["py39"]
|
|
83
|
+
|
|
84
|
+
[tool.isort]
|
|
85
|
+
profile = "black"
|
|
86
|
+
line_length = 88
|
|
87
|
+
multi_line_output = 3
|
|
88
|
+
|
|
89
|
+
[tool.mypy]
|
|
90
|
+
packages = ["pkynetics"]
|
|
91
|
+
python_version = "3.9"
|
|
92
|
+
warn_return_any = true
|
|
93
|
+
warn_unused_configs = true
|
|
94
|
+
disallow_untyped_defs = true
|
|
95
|
+
disallow_incomplete_defs = true
|
|
96
|
+
check_untyped_defs = true
|
|
97
|
+
disallow_untyped_decorators = true
|
|
98
|
+
no_implicit_optional = true
|
|
99
|
+
warn_redundant_casts = true
|
|
100
|
+
warn_unused_ignores = true
|
|
101
|
+
warn_no_return = true
|
|
102
|
+
warn_unreachable = true
|
|
103
|
+
explicit_package_bases = true
|
|
104
|
+
namespace_packages = true
|
|
105
|
+
|
|
106
|
+
[[tool.mypy.overrides]]
|
|
107
|
+
module = ["scipy.*", "matplotlib.*", "seaborn.*", "statsmodels.*", "pandas.*", "chardet"]
|
|
108
|
+
ignore_missing_imports = true
|
|
109
|
+
|
|
110
|
+
[tool.pytest.ini_options]
|
|
111
|
+
addopts = "--cov=pkynetics --cov-report=term --cov-report=xml"
|
|
112
|
+
testpaths = ["tests"]
|
|
113
|
+
python_files = "test_*.py"
|
|
114
|
+
|
|
115
|
+
[tool.sphinx]
|
|
116
|
+
source-dir = "docs"
|
|
117
|
+
build-dir = "docs/_build"
|
|
118
|
+
config-dir = "docs"
|
|
File without changes
|