pyJac 1.0.6

Documentation

The full documentation for pyJac can be found at http://slackha.github.io/pyJac/.

User Group

Further support can be found at our user group, or by opening an issue on our github repo.

Installation

Detailed installation instructions can be found in the full documentation. The easiest way to install pyJac is via conda. You can install to your environment with

> conda install -c slackha pyjac

pyJac can also be installed from PyPI using pip:

pip install pyjac

or, using the downloaded source code, installed as a Python module:

> python setup.py install

Usage

pyJac can be run as a python module:

> python -m pyjac [options]

The generated source code is placed within the out (by default) directory, which is created if it doesn’t exist initially. See the documentation or use python pyjac -h for the full list of options.

Theory

Theory, derivations, validation and performance testing can be found in the paper fully describing version 1.0.2 of pyJac: https://niemeyer-research-group.github.io/pyJac-paper/, now published via https://doi.org/10.1016/j.cpc.2017.02.004 and available openly via `arXiv:1605.03262 [physics.comp-ph] <https://arxiv.org/abs/1605.03262>`__.

License

pyJac is released under the MIT license; see the LICENSE for details.

If you use this package as part of a scholarly publication, please see CITATION.md for the appropriate citation(s).

Contributing

We welcome contributions to pyJac! Please see the guide to making contributions in the CONTRIBUTING.md file.

Code of Conduct

In order to have a more open and welcoming community, pyJac adheres to a code of conduct adapted from the Contributor Covenant code of conduct.

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

Authors

Created by Kyle Niemeyer (kyle.niemeyer@gmail.com) and Nicholas Curtis (arghdos@gmail.com)

[1.0.6] - 2018-02-21

[1.0.5.b0] - 2017-06-02

1.0.4 - 2017-04-18

1.0.3 - 2017-04-01

1.0.2 - 2017-01-18

1.0.1 - 2016-05-25

1.0 - 2016-05-07

0.9.1-beta - 2015-10-29

Changed

• Implemented the strict mass conservation formulation

• Updated CUDA implementation such that it is testable vs. pyJac c-version (and Cantera where applicable)

• More robust build folder management

• More robust mapping for strict mass conservation

0.9-beta - 2015-10-02

Added

• First working / tested version of pyJac

BibTeX entry:

@misc{pyJac,
    author = {Kyle E Niemeyer and Nicholas J Curtis},
    year = 2017,
    title = {{pyJac} v1.0.4},
    doi = {10.5281/zenodo.######},
    url = {https://github.com/slackha/pyJac},
}

In both cases, please update the entry with the version used. The DOI for the latest version can be found in the badge at the top. If you would like to cite a specific, older version, the DOIs for each release are:

• v1.0.4: 10.5281/zenodo.555950

• v1.0.3: 10.5281/zenodo.439682

• v1.0.2: 10.5281/zenodo.251144