Welcome to CanSen’s documentation!

CanSen is a Python script that provides a SENKIN-like wrapper around the open-source Cantera package. The motivation for this project is to ease the transition from SENKIN to using Cantera. Many researchers have knowledge of how to build SENKIN input files, and many may have SENKIN input files available that they use. CanSen enables the use of SENKIN-formatted input files with Cantera.

CanSen can be used with any version of Python >= 2.6.

CanSen is hosted at GitHub, if you are interested in the source code and development. Please report any bugs there.

Notice

I have tested this software to the best of my abilities. Any user uses this software with the express understanding that there may be bugs, non-working features, and other gremlins that prevent a user from using the software to their specification. If you find problems, please report them in the issue tracker.

ALL USERS ARE ENCOURAGED TO CHECK THEIR RESULTS WITH AN INDEPENDENT PROGRAM! Researchers especially are encouraged not to treat this software as a black box. Always remember: Garbage in equals garbage out!

License

Also available in LICENSE.txt

The MIT License (MIT)

Copyright (c) 2014 Bryan W. Weber

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.

Indices and tables