Metadata-Version: 2.4
Name: PyTeCK
Version: 0.2.6
Summary: Evaluation of chemical kinetic models with experimental data
Project-URL: Homepage, https://github.com/pr-omethe-us/PyTeCK
Project-URL: Repository, https://github.com/pr-omethe-us/PyTeCK
Project-URL: Issues, https://github.com/pr-omethe-us/PyTeCK/issues
Author-email: "Kyle E. Niemeyer" <kyle.niemeyer@oregonstate.edu>
License: MIT License
License-File: LICENSE
Keywords: chemical_kinetics
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
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.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering :: Chemistry
Requires-Python: >=3.10
Requires-Dist: cantera>=3.0
Requires-Dist: numpy>=2.0.0
Requires-Dist: pint>=0.20
Requires-Dist: pyked>=0.5.0
Requires-Dist: pyyaml>=5.1
Requires-Dist: scipy>=1.7
Requires-Dist: tables>=3.7
Description-Content-Type: text/markdown

# PyTeCK

[![DOI](https://zenodo.org/badge/53542212.svg)](https://zenodo.org/badge/latestdoi/53542212)
![CI](https://github.com/pr-omethe-us/PyTeCK/actions/workflows/ci.yml/badge.svg)
[![Coverage Status](https://coveralls.io/repos/github/pr-omethe-us/PyTeCK/badge.svg?branch=main)](https://coveralls.io/github/pr-omethe-us/PyTeCK)
[![GitHub Release](https://img.shields.io/github/release/pr-omethe-us/PyTeCK.svg)](https://github.com/pr-omethe-us/PyTeCK/releases)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)

This software package automatically evaluates the performance of a chemical kinetic
model using experimental data given in a specified YAML format.

## Installation

[![PyPI](https://img.shields.io/pypi/v/pyteck)](https://pypi.org/project/pyteck/)
[![Anaconda](https://anaconda.org/pr-omethe-us/pyteck/badges/version.svg)](https://anaconda.org/pr-omethe-us/pyteck)

The easiest way to install PyTeCK is via `conda`. You can install to your environment with

    > conda install -c pr-omethe-us pyteck

which will also handle all the dependencies. Alternatively, you can install from
PyPI with

    > pip install pyteck

If you prefer to install manually, or want a particular version outside of the
tagged releases distributed to those services, you can download the source files
from this repository, navigate to the directory, and install using `pip`:

    > pip install .

## Usage

Once installed, the full list of options can be seen using `pyteck -h` or `pyteck --help`.

## Code of Conduct

In order to have a more open and welcoming community, PyTeCK adheres to a code of
conduct adapted from the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

Please adhere to this code of conduct in any interactions you have in the PyTeCK community.
It is strictly enforced on all official PyTeCK repositories, websites, and resources.
If you encounter someone violating these terms, please let
[@kyleniemeyer](https://github.com/kyleniemeyer) know via email at <kyle.niemeyer@gmail.com>
and we will address it as soon as possible.

## Citation

If you use this package as part of a scholarly publication, please refer to
[CITATION.md](https://github.com/pr-omethe-us/PyTeCK/blob/master/CITATION.md)
for instructions on how to cite this resource directly.

## License

PyTeCK is released under the MIT license; see
[LICENSE](https://github.com/pr-omethe-us/PyTeCK/blob/master/LICENSE) for details.