Catera with additional transport models
Find a file
Ray Speth 8a9eabeeac [clib] Add buffer length argument to all functions returning strings
If the buffer is not long enough, the string is truncated and the return value
is the required buffer length. Otherwise, the return value is 0.
2016-10-18 11:21:42 -04:00
data Remove dummy element from elements.xml 2016-08-30 20:31:31 -04:00
doc Add support for Sundials 2.7.0 2016-10-15 20:50:15 -04:00
ext [SCons] Fix license file generation when using system version of fmt 2016-07-05 15:11:33 -04:00
include/cantera [clib] Add buffer length argument to all functions returning strings 2016-10-18 11:21:42 -04:00
interfaces [Matlab] Fix ThermoPhase 'clear' method 2016-10-18 11:21:42 -04:00
platform/posix [SCons] Install to lib64 directory on operating systems that use this 2016-07-25 14:42:46 -04:00
samples [Doc] Adjust example docstrings to get better automatic summaries 2016-10-14 17:20:18 -04:00
site_scons [SCons] Install license file with licenses for 3rd-party code 2016-06-24 15:27:20 -04:00
src [clib] Add buffer length argument to all functions returning strings 2016-10-18 11:21:42 -04:00
test [Test] Make reaction rate comparisons more granular 2016-10-15 13:36:38 -04:00
test_problems Replace existing copyright notices with uniform copyright/license info 2016-10-10 22:19:01 -04:00
.gitignore Update .gitignore 2016-10-15 11:44:52 -04:00
.gitmodules Add Eigen submodule (mirrored on Github at Cantera/eigen-mirror) 2016-05-14 21:56:17 -04:00
.travis.yml Fix Travis build on OS X 2016-10-10 00:32:48 -04:00
appveyor.yml Add Appvyeor config file 2016-09-06 20:34:24 -04:00
AUTHORS Add institutional affiliations to AUTHORS 2016-10-10 21:18:54 -04:00
INSTALL Added INSTALL with basic instructions for building with SCons 2012-07-03 17:49:59 +00:00
License.txt Update copyright statement in License.txt 2016-10-10 21:20:53 -04:00
README.rst Fix Travis links in README.rst 2016-10-14 20:05:13 -04:00
SConstruct Add support for Sundials 2.7.0 2016-10-15 20:50:15 -04:00

*******
Cantera
*******

Version 2.3.0a3 (development)

What is Cantera?
================

Cantera is an open-source collection of object-oriented software tools for
problems involving chemical kinetics, thermodynamics, and transport
processes. Among other things, it can be used to:

* Evaluate thermodynamic and transport properties of mixtures
* Compute chemical equilibrium
* Evaluate species chemical production rates
* Conduct kinetics simulations with large reaction mechanisms
* Simulate one-dimensional flames
* Conduct reaction path analysis
* Create process simulations using networks of stirred reactors
* Model non-ideal fluids

Cantera can be used from Python and Matlab, or in applications written in C++
and Fortran 90. A number of `examples of Cantera's capabilities
<https://github.com/Cantera/cantera-jupyter>`_ are available in the form of
Jupyter notebooks. These examples can be tried interactively, in the cloud by
using the following Binder link:

.. image:: http://mybinder.org/badge.svg
    :target: http://mybinder.org:/repo/cantera/cantera-jupyter

Installation
============

`Installation instructions for the current release of Cantera
<http://cantera.github.io/docs/sphinx/html/install.html>`_ are available from
the main `Cantera documentation site
<http://cantera.github.io/docs/sphinx/html/index.html>`_. Installers are
provided for Windows (MSI packages), Mac OS X (through Homebrew), and
Ubuntu. Anaconda packages containing the Cantera Python module are also
available for Windows, OS X, and Linux.

.. image:: https://anaconda.org/cantera/cantera/badges/installer/conda.svg
    :target: https://conda.anaconda.org/cantera

For other platforms, or for users wishing to install a development version of
Cantera, `compilation instructions
<http://cantera.github.io/docs/sphinx/html/compiling.html>`_ are also available.

Documentation
=============

The `documentation <http://cantera.github.io/docs/sphinx/html/index.html>`_
offers a number of starting points:

- `Python tutorial
  <http://cantera.github.io/docs/sphinx/html/cython/tutorial.html>`_
- `A guide to Cantera's input file format
  <http://cantera.github.io/docs/sphinx/html/cti/index.html>`_
- `A list of frequently asked questions
  <http://cantera.github.io/docs/sphinx/html/faq.html>`_

`Documentation for the development version of Cantera
<http://cantera.github.com/dev-docs/sphinx/html/index.html>`_ is also available.

Development Site
================

The `latest Cantera source code <https://github.com/Cantera/cantera>`_, the
`issue tracker <https://github.com/Cantera/cantera/issues>`_ for bugs and
enhancement requests, `downloads of Cantera releases and binary installers
<https://github.com/Cantera/cantera/releases>`_ , and the `Cantera wiki
<https://github.com/Cantera/cantera/wiki>`_ can all be found on Github.

Users' Group
============

The `Cantera Users' Group <http://groups.google.com/group/cantera-users>`_ is a
message board / mailing list for discussions amongst Cantera users.

Continuous Integration Status
=============================

Travis builds (Linux & OS X):

.. image:: https://travis-ci.org/Cantera/cantera.svg?branch=master
    :target: https://travis-ci.org/Cantera/cantera

Appveyor builds (Windows):

.. image:: https://ci.appveyor.com/api/projects/status/auhd35qn9cdmkpoj?svg=true
    :target: https://ci.appveyor.com/project/Cantera/cantera